nxtomomill.io.framegroup.FrameGroup#

class nxtomomill.io.framegroup.FrameGroup(url, frame_type, copy=None)[source]#

Bases: object

class used to store information regarding a group of frame

contains the frames type and if we should provide a copy of those in the output file or not

Parameters:

  • url (DataUrl | str | None) – url to access the frame group (bliss scan entry). If provided as a string should fit a DataUrl or be the data path on the input file

  • frame_type (AcquisitionStep | str) – frame type (dark, projection …). If provided as str should be an AcquisitionStep value

  • copy (bool | None) – should we copy the data frame in the output file. If set to None then the value will be set to the default copy behavior during processing

__init__(url, frame_type, copy=None)[source]#

Methods

__init__(url, frame_type[, copy])

frm_str(input_str)

Create an instance of FrameGroup from it string representation.

list_to_str(urls)

Convert the list of urls to a string that can be pass to the .cfg file

str_representation(only_data_path, ...)

Util function to print the possible input string for this FrameGroup.

Attributes

copy

rtype:

bool | None

frame_type

rtype:

AcquisitionStep

url

rtype:

DataUrl | None
class Info(value)[source]#

Bases: Enum

An enumeration.

static frm_str(input_str)[source]#

Create an instance of FrameGroup from it string representation.

static list_to_str(urls)[source]#

Convert the list of urls to a string that can be pass to the .cfg file

str_representation(only_data_path, with_copy, with_prefix_key)[source]#

Util function to print the possible input string for this FrameGroup.

Parameters:

  • only_data_path (bool) – if True consider the input file frame group is contained in the input file and the string representing the url can be only the data path

  • with_copy (bool) – if true display the copy information

  • with_prefix_key (bool) – if true provide the string with the keys as prefix (frame_type=XXX, copy=…)

Return type:

str

Show Source