Files
Jungfraujoch/python-client/docs/ImageFormatSettings.md
2024-10-11 11:11:37 +02:00

2.0 KiB

ImageFormatSettings

Properties

Name Type Description Notes
summation bool Enable summation of images to a given image_time If disabled images are saved according to original detector speed, but image count is adjusted
geometry_transform bool Place module read-out into their location on composed detector and extend multipixels
jungfrau_conversion bool Convert pixel value in ADU to photon counts/energy Only affects JUNGFRAU detector
jungfrau_conversion_factor_ke_v float Used to convert energy deposited into pixel to counts If not provided incident_energy_keV is used [optional]
bit_depth_image int Bit depth of resulting image (it doesn't affect the original detector value) If not provided value is adjusted automatically [optional]
signed_output bool Controls if pixels have signed output If not provided value is adjusted automatically [optional]
mask_module_edges bool Mask 1 pixel on the module boundary [default to True]
mask_chip_edges bool Mask multipixels on chip boundary [default to True]

Example

from jfjoch_client.models.image_format_settings import ImageFormatSettings

# TODO update the JSON string below
json = "{}"
# create an instance of ImageFormatSettings from a JSON string
image_format_settings_instance = ImageFormatSettings.from_json(json)
# print the JSON string representation of the object
print(ImageFormatSettings.to_json())

# convert the object into a dict
image_format_settings_dict = image_format_settings_instance.to_dict()
# create an instance of ImageFormatSettings from a dict
image_format_settings_from_dict = ImageFormatSettings.from_dict(image_format_settings_dict)

[Back to Model list] [Back to API list] [Back to README]