Skip to content

Commit a7a6b05

Browse files
committed
Updated notes and type hints for 'camera'
1 parent 4cf7e2a commit a7a6b05

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/murfey/util/config.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class MachineConfig(BaseModel):
5252
"""
5353
Information about the hardware and software on the instrument machine
5454
"""
55-
camera: str = Field(
55+
camera: Literal["FALCON", "K3_FLIPX", "K3_FLIPY"] = Field(
5656
default="FALCON",
5757
description=(
5858
"Name of the camera used by the TEM. This is only relevant for TEMs to "
@@ -61,10 +61,11 @@ class MachineConfig(BaseModel):
6161
"Options: 'FALCON', 'K3_FLIPX', 'K3_FLIPY'"
6262
),
6363
# NOTE:
64-
# Supported options: Falcon 4, Falcon 4I, K2, K3 (superres)
65-
# _FLIPX/_FLIPY is to tell it what to do with the gain reference
66-
# Will need to create a new key to record whether the gain reference image
67-
# needs to be flippedflip_gain: X, Y, None
64+
# Eventually need to support Falcon 4, Falcon 4I, K2, K3 (superres)
65+
# _FLIPX/_FLIPY is to tell it what to do with the gain reference.
66+
# - These will eventually be removed, leaving only the camera name
67+
# - Will need to create a new key to record whether the gain reference
68+
# image needs to be flippedflip_gain: X, Y, None
6869
)
6970
superres: bool = Field(
7071
default=False,

0 commit comments

Comments
 (0)