PyJEM.femtus.worksheet¶
- PyJEM.femtus.worksheet.get_worksheets()¶
Retrieve all worksheets.
- Returns:
List of worksheet groups.
Key
Type
Value
Id
str
Identifier of the worksheet group.
Title
str
Display title of the worksheet group.
Children
list[dict]
Child worksheet list.
=> See Children items.
Children items
Key
Type
Value
Id
str
Identifier of the child worksheet.
Title
str
Display title of the child worksheet.
- Return type:
list[dict]
Examples
>>> get_worksheets() [{ 'Id': '71e87c6b-96ee-4ee4-857d-267c309acfdb', 'Title': 'Live', 'Children': [{ 'Id': '10645fdc-2966-4d6a-ae2d-8e2d12e10ffc', 'Title': 'Test Camera Name 0' }] }]
- PyJEM.femtus.worksheet.get_worksheet(worksheet_id)¶
Retrieve a worksheet by its ID.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
- Returns:
Worksheet metadata and child content summaries.
Key
Type
Value
Id
str
Identifier of the worksheet.
Title
str
Worksheet title.
IsActive
bool
Whether the worksheet is currently active.
IsEdited
bool
Whether the worksheet has unsaved modifications.
Children
list[dict]
Child worksheet elements.
=> See Worksheet child items.
Worksheet child items
Key
Type
Value
Id
str
Identifier of the child worksheet element.
Title
str
Title of the child worksheet element.
IsActive
bool
Whether the child worksheet element is active.
IsEdited
bool
Whether the child worksheet element has unsaved modifications.
IsLive
bool
Whether the child worksheet element is live.
ContentSummary
dict
Content summary for the child worksheet element.
- Return type:
dict
Examples
>>> get_worksheet("ba3829a2-78d9-476e-b633-a7c11124e125") { "Children": [ { "ContentSummary": { "ContentType": "ImageContent", "Id": "ba3829a2-78d9-476e-b633-a7c11124e125" }, "Id": "7521de2a-18cf-4d54-8922-e9d282aafa38", "IsActive": False, "IsEdited": False, "IsLive": False, "Title": "Test Camera Name 0 20251215_110818" }, { "ContentSummary": { "ContentType": "GraphContent", "Id": "2ac7c2a1-fa0b-460a-9a2f-0d7909c96230" }, "Id": "19162f86-19ce-4bf8-b956-0b1d7c1fe3f5", "IsActive": False, "IsEdited": False, "IsLive": False, "Title": "EELS Live Spectrum" }, ], "Id": "a4fef4e1-90d9-4334-bedf-671b575e2db4", "IsActive": True, "IsEdited": True, "Title": "sample_sheet" }
- PyJEM.femtus.worksheet.create_worksheet()¶
Create a new worksheet.
- Returns:
Newly created worksheet metadata.
Key
Type
Value
Id
str
maked new worksheet id.
IsActive
bool
Whether the worksheet is active.
IsEdited
bool
Whether the worksheet has been edited.
Title
str
Worksheet title.
- Return type:
dict
Examples
>>> create_worksheet() { "Id": "6917eaf6-337c-4135-9cdd-aeaf1d341ddb", "IsActive": True, "IsEdited": True, "Title": "1216_152330" }
- PyJEM.femtus.worksheet.delete_worksheet(worksheet_id)¶
Delete a worksheet by its ID.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
- Return type:
None
Examples
>>> delete_worksheet('c759972f-75b9-4777-9048-ee2799e0f1dd')
- PyJEM.femtus.worksheet.activate_worksheet(worksheet_id)¶
Activate a worksheet.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
- Return type:
None
Examples
>>> activate_worksheet('a4fef4e1-90d9-4334-bedf-671b575e2db4')
- PyJEM.femtus.worksheet.update_worksheet(worksheet_id, title, **kw)¶
Update a worksheet by its ID.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
title (str) – The title of a worksheet.
- Returns:
Updated worksheet metadata.
Key
Type
Value
Id
str
Identifier of the worksheet.
IsActive
bool
Whether the worksheet is active.
IsEdited
bool
Whether the worksheet has been edited.
Title
str
Updated worksheet title.
- Return type:
dict
Examples
>>> update_worksheet('a4fef4e1-90d9-4334-bedf-671b575e2db4', 'test_20251216_152332')
- PyJEM.femtus.worksheet.copy_active_worksheet(worksheet_id)¶
Copy a worksheet by its ID.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
- Return type:
None
Examples
>>> copy_worksheet('a4fef4e1-90d9-4334-bedf-671b575e2db4')
- PyJEM.femtus.worksheet.paste_to_worksheet(worksheet_id)¶
Paste data into a worksheet.
- Parameters:
worksheet_id (str) – The ID of the worksheet.
- Returns:
Paste result.
Key
Type
Value
Id
str
Identifier of the created worksheet element.
- Return type:
dict
Examples
>>> paste_to_worksheet('a4fef4e1-90d9-4334-bedf-671b575e2db4') {'Id': '5fec9050-5ae9-4594-b435-6b3ee90d77ca'}
- PyJEM.femtus.worksheet.get_worksheet_element(worksheet_element_id)¶
Retrieve a worksheet element by its ID.
- Parameters:
worksheet_element_id (str) – The ID of the worksheet element.
- Returns:
Worksheet element metadata.
Key
Type
Value
Id
str
Identifier of the worksheet element.
Title
str
Title of the worksheet element.
IsActive
bool
Whether the worksheet element is active.
IsEdited
bool
Whether the worksheet element has been edited.
IsLive
bool
Whether the worksheet element is live.
ContentSummary
dict
Content summary metadata.
Worksheet element content summary items
Key
Type
Value
ContentType
str
Content type such as
ImageContentorGraphContent.Id
str
Identifier of the content object.
- Return type:
dict
Examples
>>> get_worksheet_element('7521de2a-18cf-4d54-8922-e9d282aafa38') { "ContentSummary": { "ContentType": "ImageContent", "Id": "ba3829a2-78d9-476e-b633-a7c11124e125" }, "Id": "7521de2a-18cf-4d54-8922-e9d282aafa38", "IsActive": False, "IsEdited": True, "IsLive": False, "Title": "Test Camera Name 0 20251215_110818" }
- PyJEM.femtus.worksheet.activate_worksheet_element(worksheet_element_id)¶
Activate a worksheet element.
- Parameters:
worksheet_element_id (str) – The ID of the worksheet element.
- Return type:
None
Examples
>>> activate_worksheet_element('7521de2a-18cf-4d54-8922-e9d282aafa38')
- PyJEM.femtus.worksheet.get_image_content(image_content_id)¶
Retrieve image content by its ID.
- Parameters:
image_content_id (str) – The ID of the image content.
- Returns:
Image content and child dataset metadata.
Key
Type
Value
Id
str
Identifier of the parent image content.
Children
list[dict]
Child dataset entries.
=> See Worksheet dataset child items.
- Return type:
dict
Examples
>>> get_image_content("img1") { "Children": [ { "Clump": { "Id": "fb858046-312b-4128-93fa-504ceb719345", "Information": { "DataInformation": { "Channel": 1, "ChannelType": "GrayScale", "DataBytes": 2, "DimensionLength": 2, "Dimensions": [ 512, 512 ], "IsRangeFixed": False, "MaximumPossibleIntensity": 1.7976931348623157e+308, "MinimumPossibleIntensity": -1.7976931348623157e+308, "TypeInfo": 0 }, "Header": { "ClumpId": "fb858046-312b-4128-93fa-504ceb719345", "ClumpType": "Clump", "DataSubType": "", "DataType": "EELS_Camera", "DetectorType": 1, "Name": "", "Version": "1.0.0" }, "MeasurementInformation": { "CalibrationCoefficients": [ { "Offset": 0, "Scale": 66.66666666666667, "Unit": "Nanometer" }, { "Offset": 0, "Scale": 66.66666666666667, "Unit": "Nanometer" } ] }, "Tags": { "Detector": { "BinningSize": { "X": 2, "Y": 2 }, "DetectorKind": "Test Camera Name 0", "ExposureTimeValue": 123.456, "FrameIntegration": 1, "GainIndex": 0, "ImagingArea": { "Height": 512, "Width": 512, "X": 256, "Y": 128 }, "Manufacturer": "Test Vendor", "ModelCode": "Test Camera Name 0", "ModelDisplayName": "Test Camera Name 0", "OffsetIndex": 0, "PixelsPerMeter": { "Horizontal": 2500, "Vertical": 2500 }, "SoftwareBinningSize": { "X": 1, "Y": 1 }, "SoftwareCroppingArea": { "Height": 512, "Width": 512, "X": 0, "Y": 0 } }, "EELS": { "CameraLengthCoefficient": 1, "DataType": "Image", "Dispersion": 0, "DriftTubeVoltage": 0, "EnergyLossOffset": 0, "EntranceApertureHoleString": "Out", "EntranceApertureInserted": False, "FilterMode": "STEM-EELS", "FilterSubmode": "align", "HighTensionOffset": 0, "MagnificationValue": 1, "SectorOffset": 0, "SlitInserted": False, "SlitMode": "Out", "SlitWidth": 0 }, "EOS": { "CameraLength": 1, "CameraLengthString": "1m", "ConvergenceAngleAlphaNumber": 0, "ImageFormingMode": "MAG", "MagnificationString": "x3000", "MagnificationValue": 3000, "OperationMode": "TEM", "RockingAngle": 0, "SpotSizeNumber": 0 }, "General": { "AcquisitionDateTime": "20251215110818759", "AcquisitionId": "7c9ccd64-7579-48f1-b85d-364732fc9052", "AnalysisDateTime": "20251215110818759", "AnalysisId": "bdb049ce-0ce3-449c-b178-c7c7cf74e4f1", "Comment": "", "DateTime": "20251215110818759", "Instrument": "JEM-ARM200F", "Manufacturer": "JEOL Ltd.", "Operator": "User", "ProductName": "FEMTUS", "ProductVersion": "2.0.0", "Specimen": "Specimen", "UpdateDateTime": "20251215110818759", "UpdateProductName": "FEMTUS", "UpdateProductVersion": "2.0.0" }, "HT": { "AccelerationVoltage": 200000, "EnergyShift": 0, "GunType": "Cfeg" }, "Stage": { "PX": { "Position": 0 }, "PY": { "Position": 0 }, "PZ": { "Position": 0 }, "TX": { "Position": 0 }, "TY": { "Position": 0 }, "TZ": { "Position": 0 }, "X": { "Position": 0 }, "Y": { "Position": 0 }, "Z": { "Position": 0 } } } }, "ViewInformation": { "Header": { "ClumpId": "fb858046-312b-4128-93fa-504ceb719345", "Version": "2.0.0" }, "Tags": {} } }, "Id": "781519d9-9063-4fb3-a392-8f27d837c6d4", "IsSelected": False } ], "Id": "ba3829a2-78d9-476e-b633-a7c11124e125" }
- PyJEM.femtus.worksheet.get_graph_content(graph_content_id)¶
Retrieve graph content by its ID.
- Parameters:
graph_content_id (str) – The ID of the graph content.
- Returns:
Graph content and child dataset metadata.
Key
Type
Value
Id
str
Identifier of the parent graph content.
Children
list[dict]
Child dataset entries.
=> See Worksheet dataset child items.
- Return type:
dict
Examples
>>> get_graph_content('2ac7c2a1-fa0b-460a-9a2f-0d7909c96230') { "Children": [ { "Clump": { "Id": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Information": { "DataInformation": { "Channel": 1, "ChannelType": "GrayScale", "DataBytes": 4, "DimensionLength": 1, "Dimensions": [ 512 ], "IsRangeFixed": False, "MaximumPossibleIntensity": 1.7976931348623157e+308, "MinimumPossibleIntensity": -1.7976931348623157e+308, "TypeInfo": 2 }, "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "ClumpType": "Clump", "DataSubType": "", "DataType": "EELS_Point_Spectrum", "DetectorType": 1, "Name": "Spectrum", "Version": "1.0.0" }, "MeasurementInformation": { "CalibrationCoefficients": [ { "Offset": 0, "Scale": 200000, "Unit": "Nanometer" } ] }, "Tags": { "Aperture": { "CL": { "ApertureHoleString": "0" }, "CL2": { "ApertureHoleString": "0" }, "OL": { "ApertureHoleString": "0" }, "SA": { "ApertureHoleString": "0" } }, "Detector": { "BinningSize": { "X": 2, "Y": 2 }, "DetectorKind": "Test Camera Name 0", "ExposureTimeValue": 123.456, "FrameIntegration": 1, "ImagingArea": { "Height": 512, "Width": 512, "X": 256, "Y": 128 }, "Manufacturer": "Test Vendor", "ModelCode": "Test Camera Name 0", "ModelDisplayName": "Test Camera Name 0", "PixelsPerMeter": { "Horizontal": 200000, "Vertical": 200000 }, "SoftwareBinningSize": { "X": 1, "Y": 1 }, "SoftwareCroppingArea": { "Height": 512, "Width": 512, "X": 0, "Y": 0 } }, "EELS": { "CameraLengthCoefficient": 1, "DataType": "Image", "Dispersion": 0, "DriftTubeVoltage": 0, "EnergyLossOffset": 0, "EntranceApertureHoleString": "Out", "EntranceApertureInserted": False, "FilterMode": "STEM-EELS", "FilterSubmode": "align", "HighTensionOffset": 0, "MagnificationValue": 1, "SectorOffset": 0, "SlitInserted": False, "SlitMode": "Out", "SlitWidth": 0 }, "EOS": { "CameraLength": 0.015, "CameraLengthString": "1.5cm", "ConvergenceAngleAlphaNumber": 0, "ImageFormingMode": "MAG", "MagnificationString": "x20k", "MagnificationValue": 20000, "OperationMode": "Scanning", "RockingAngle": 0, "SpotSizeNumber": 0 }, "General": { "AcquisitionDateTime": "20251216135747868", "AcquisitionId": "93642131-d88c-4016-8390-8f05088a6c2d", "AnalysisDateTime": "20251216135747868", "AnalysisId": "dd22b600-b04b-4675-8c1d-758f7d3e15fc", "Comment": "", "DateTime": "20251216135747873", "Instrument": "JEM-ARM200F", "Manufacturer": "JEOL Ltd.", "ProductName": "FEMTUS", "ProductVersion": "2.0.0.0", "UpdateDateTime": "20251216135747873", "UpdateProductName": "FEMTUS", "UpdateProductVersion": "2.0.0.0" }, "HT": { "AccelerationVoltage": 200000, "EnergyShift": 0, "GunType": "Cfeg" }, "SAAF": { "DPC": { "RotationCorrectionAngle": 0 }, "OBF": { "DefocusMode": "WPOA_zero", "IncidentHalfAngle": 24, "SampleThickness": 10 } }, "ScanGenerator": {}, "Stage": { "PX": { "Position": 0 }, "PY": { "Position": 0 }, "PZ": { "Position": 0 }, "TX": { "Position": 0 }, "TY": { "Position": 0 }, "TZ": { "Position": 0 }, "X": { "Position": 0 }, "Y": { "Position": 0 }, "Z": { "Position": 0 } } } }, "ViewInformation": { "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Version": "2.0.0" }, "Tags": {} } }, "Id": "f5a51464-ac63-4af8-b370-bcfe3b72847c", "IsSelected": False } ], "Id": "2ac7c2a1-fa0b-460a-9a2f-0d7909c96230" }
- PyJEM.femtus.worksheet.get_data_set(data_set_id)¶
Retrieve a data set by its ID.
- Parameters:
data_set_id (str) – The ID of the data set.
- Returns:
Data set metadata and clump information.
Key
Type
Value
Id
str
Identifier of the data set.
IsSelected
bool
Whether the data set is currently selected.
Clump
dict
Clump metadata.
=> See Clump items.
- Return type:
dict
Examples
>>> get_data_set('f5a51464-ac63-4af8-b370-bcfe3b72847c') { "Clump": { "Id": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Information": { "DataInformation": { "Channel": 1, "ChannelType": "GrayScale", "DataBytes": 4, "DimensionLength": 1, "Dimensions": [ 512 ], "IsRangeFixed": False, "MaximumPossibleIntensity": 1.7976931348623157e+308, "MinimumPossibleIntensity": -1.7976931348623157e+308, "TypeInfo": 2 }, "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "ClumpType": "Clump", "DataSubType": "", "DataType": "EELS_Point_Spectrum", "DetectorType": 1, "Name": "Spectrum", "Version": "1.0.0" }, "MeasurementInformation": { "CalibrationCoefficients": [ { "Offset": 0, "Scale": 200000, "Unit": "Nanometer" } ] }, "Tags": { "Aperture": { "CL": { "ApertureHoleString": "0" }, "CL2": { "ApertureHoleString": "0" }, "OL": { "ApertureHoleString": "0" }, "SA": { "ApertureHoleString": "0" } }, "Detector": { "BinningSize": { "X": 2, "Y": 2 }, "DetectorKind": "Test Camera Name 0", "ExposureTimeValue": 123.456, "FrameIntegration": 1, "ImagingArea": { "Height": 512, "Width": 512, "X": 256, "Y": 128 }, "Manufacturer": "Test Vendor", "ModelCode": "Test Camera Name 0", "ModelDisplayName": "Test Camera Name 0", "PixelsPerMeter": { "Horizontal": 200000, "Vertical": 200000 }, "SoftwareBinningSize": { "X": 1, "Y": 1 }, "SoftwareCroppingArea": { "Height": 512, "Width": 512, "X": 0, "Y": 0 } }, "EELS": { "CameraLengthCoefficient": 1, "DataType": "Image", "Dispersion": 0, "DriftTubeVoltage": 0, "EnergyLossOffset": 0, "EntranceApertureHoleString": "Out", "EntranceApertureInserted": False, "FilterMode": "STEM-EELS", "FilterSubmode": "align", "HighTensionOffset": 0, "MagnificationValue": 1, "SectorOffset": 0, "SlitInserted": False, "SlitMode": "Out", "SlitWidth": 0 }, "EOS": { "CameraLength": 0.015, "CameraLengthString": "1.5cm", "ConvergenceAngleAlphaNumber": 0, "ImageFormingMode": "MAG", "MagnificationString": "x20k", "MagnificationValue": 20000, "OperationMode": "Scanning", "RockingAngle": 0, "SpotSizeNumber": 0 }, "General": { "AcquisitionDateTime": "20251216135747868", "AcquisitionId": "93642131-d88c-4016-8390-8f05088a6c2d", "AnalysisDateTime": "20251216135747868", "AnalysisId": "dd22b600-b04b-4675-8c1d-758f7d3e15fc", "Comment": "", "DateTime": "20251216135747873", "Instrument": "JEM-ARM200F", "Manufacturer": "JEOL Ltd.", "ProductName": "FEMTUS", "ProductVersion": "2.0.0.0", "UpdateDateTime": "20251216135747873", "UpdateProductName": "FEMTUS", "UpdateProductVersion": "2.0.0.0" }, "HT": { "AccelerationVoltage": 200000, "EnergyShift": 0, "GunType": "Cfeg" }, "SAAF": { "DPC": { "RotationCorrectionAngle": 0 }, "OBF": { "DefocusMode": "WPOA_zero", "IncidentHalfAngle": 24, "SampleThickness": 10 } }, "ScanGenerator": {}, "Stage": { "PX": { "Position": 0 }, "PY": { "Position": 0 }, "PZ": { "Position": 0 }, "TX": { "Position": 0 }, "TY": { "Position": 0 }, "TZ": { "Position": 0 }, "X": { "Position": 0 }, "Y": { "Position": 0 }, "Z": { "Position": 0 } } } }, "ViewInformation": { "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Version": "2.0.0" }, "Tags": {} } }, "Id": "f5a51464-ac63-4af8-b370-bcfe3b72847c", "IsSelected": False }
- PyJEM.femtus.worksheet.get_data_set_processor(data_set_id)¶
Retrieve a data set by its ID.
- Parameters:
data_set_id (str) – The ID of the data set.
- Returns:
Parent data set metadata.
Key
Type
Value
ParentDataSets
list[dict]
Parent dataset entries.
=> See Worksheet dataset child items.
- Return type:
dict
Note
This feature requires the input datasetid to be a child dataset. If it is not a child, a 404 error will be returned. The only way to verify if a dataset is a child is by checking the UI.
Examples
>>> get_data_set_processor('31ee57a2-b9eb-45a9-a2f3-1818ef1d37ac') { "ParentDataSets": [ { "Clump": { "Id": "fb858046-312b-4128-93fa-504ceb719345", "Information": { "DataInformation": { "Channel": 1, "ChannelType": "GrayScale", "DataBytes": 2, "DimensionLength": 2, "Dimensions": [ 512, 512 ], "IsRangeFixed": False, "MaximumPossibleIntensity": 1.7976931348623157e+308, "MinimumPossibleIntensity": -1.7976931348623157e+308, "TypeInfo": 0 }, "Header": { "ClumpId": "fb858046-312b-4128-93fa-504ceb719345", "ClumpType": "Clump", "DataSubType": "", "DataType": "EELS_Camera", "DetectorType": 1, "Name": "", "Version": "1.0.0" }, "MeasurementInformation": { "CalibrationCoefficients": [ { "Offset": 0, "Scale": 66.66666666666667, "Unit": "Nanometer" }, { "Offset": 0, "Scale": 66.66666666666667, "Unit": "Nanometer" } ] }, "Tags": { "Detector": { "BinningSize": { "X": 2, "Y": 2 }, "DetectorKind": "Test Camera Name 0", "ExposureTimeValue": 123.456, "FrameIntegration": 1, "GainIndex": 0, "ImagingArea": { "Height": 512, "Width": 512, "X": 256, "Y": 128 }, "Manufacturer": "Test Vendor", "ModelCode": "Test Camera Name 0", "ModelDisplayName": "Test Camera Name 0", "OffsetIndex": 0, "PixelsPerMeter": { "Horizontal": 2500, "Vertical": 2500 }, "SoftwareBinningSize": { "X": 1, "Y": 1 }, "SoftwareCroppingArea": { "Height": 512, "Width": 512, "X": 0, "Y": 0 } }, "EELS": { "CameraLengthCoefficient": 1, "DataType": "Image", "Dispersion": 0, "DriftTubeVoltage": 0, "EnergyLossOffset": 0, "EntranceApertureHoleString": "Out", "EntranceApertureInserted": False, "FilterMode": "STEM-EELS", "FilterSubmode": "align", "HighTensionOffset": 0, "MagnificationValue": 1, "SectorOffset": 0, "SlitInserted": False, "SlitMode": "Out", "SlitWidth": 0 }, "EOS": { "CameraLength": 1, "CameraLengthString": "1m", "ConvergenceAngleAlphaNumber": 0, "ImageFormingMode": "MAG", "MagnificationString": "x3000", "MagnificationValue": 3000, "OperationMode": "TEM", "RockingAngle": 0, "SpotSizeNumber": 0 }, "General": { "AcquisitionDateTime": "20251215110818759", "AcquisitionId": "7c9ccd64-7579-48f1-b85d-364732fc9052", "AnalysisDateTime": "20251215110818759", "AnalysisId": "bdb049ce-0ce3-449c-b178-c7c7cf74e4f1", "Comment": "", "DateTime": "20251215110818759", "Instrument": "JEM-ARM200F", "Manufacturer": "JEOL Ltd.", "Operator": "User", "ProductName": "FEMTUS", "ProductVersion": "2.0.0", "Specimen": "Specimen", "UpdateDateTime": "20251215110818759", "UpdateProductName": "FEMTUS", "UpdateProductVersion": "2.0.0" }, "HT": { "AccelerationVoltage": 200000, "EnergyShift": 0, "GunType": "Cfeg" }, "Stage": { "PX": { "Position": 0 }, "PY": { "Position": 0 }, "PZ": { "Position": 0 }, "TX": { "Position": 0 }, "TY": { "Position": 0 }, "TZ": { "Position": 0 }, "X": { "Position": 0 }, "Y": { "Position": 0 }, "Z": { "Position": 0 } } } }, "ViewInformation": { "Header": { "ClumpId": "fb858046-312b-4128-93fa-504ceb719345", "Version": "2.0.0" }, "Tags": {} } }, "Id": "781519d9-9063-4fb3-a392-8f27d837c6d4", "IsSelected": False } ] }
- PyJEM.femtus.worksheet.get_clump(clump_id)¶
Retrieve a clump by its ID.
- Parameters:
clump_id (str) – The ID of the clump.
- Returns:
Clump metadata and view information.
Key
Type
Value
Id
str
Identifier of the clump.
Information
dict
Clump metadata block.
=> See Clump information items.
ViewInformation
dict
View-specific metadata block.
=> See Clump view information items.
Worksheet dataset child items
Key
Type
Value
Id
str
Identifier of the child data set.
IsSelected
bool
Whether the child data set is selected.
Clump
dict
Clump metadata for the child data set.
=> See Clump items.
Clump items
Key
Type
Value
Id
str
Identifier of the clump.
Information
dict
Clump metadata block.
=> See Clump information items.
ViewInformation
dict
View-specific metadata block.
=> See Clump view information items.
Clump information items
Key
Type
Value
DataInformation
dict
Data structure and numeric representation details.
=> See Clump data information items.
Header
dict
Clump header metadata.
=> See Clump header items.
MeasurementInformation
dict
Measurement calibration metadata.
Tags
dict
Acquisition metadata blocks such as detector, optical system, and stage information.
=> See Clump tag items.
Clump data information items
Key
Type
Value
Channel
int
Channel index.
ChannelType
str
Channel representation such as
GrayScale.DataBytes
int
Number of bytes per sample.
DimensionLength
int
Number of dimensions in the data.
Dimensions
list[int]
Length of each dimension.
IsRangeFixed
bool
Whether the numeric range is fixed.
MaximumPossibleIntensity
float
Maximum representable intensity value.
MinimumPossibleIntensity
float
Minimum representable intensity value.
TypeInfo
int
Numeric type identifier.
Clump header items
Key
Type
Value
ClumpId
str
Identifier of the clump.
ClumpType
str
Clump kind such as
Clump.DataSubType
str
Optional subtype for the data payload.
DataType
str
Data type name such as
EELS_CameraorEELS_Point_Spectrum.DetectorType
int
Detector type identifier.
Name
str
Display name of the clump.
Version
str
Clump metadata version.
Clump measurement information items
Key
Type
Value
CalibrationCoefficients
list[dict]
Calibration coefficient entries containing
Offset,Scale, andUnit.Clump tag items
Key
Type
Value
Detector
dict
Detector metadata including binning, imaging area, and pixel scaling.
EELS
dict
EELS acquisition metadata such as filter mode and slit settings.
EOS
dict
Electron optical system metadata such as camera length and magnification.
General
dict
General acquisition metadata such as time, instrument, and product information.
HT
dict
High tension metadata such as acceleration voltage and gun type.
Stage
dict
Stage position metadata.
Aperture
dict
Aperture metadata when included in the result.
SAAF
dict
STEM alignment and focusing metadata when included in the result.
ScanGenerator
dict
Scan generator metadata when included in the result.
Clump view information items
Key
Type
Value
Header
dict
View metadata containing
ClumpIdandVersion.Tags
dict
Reserved view-specific annotations.
- Return type:
dict
Examples
>>> get_clump('8040c4c1-1bd2-4df8-a449-3eaa92438347') { "Id": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Information": { "DataInformation": { "Channel": 1, "ChannelType": "GrayScale", "DataBytes": 4, "DimensionLength": 1, "Dimensions": [ 512 ], "IsRangeFixed": False, "MaximumPossibleIntensity": 1.7976931348623157e+308, "MinimumPossibleIntensity": -1.7976931348623157e+308, "TypeInfo": 2 }, "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "ClumpType": "Clump", "DataSubType": "", "DataType": "EELS_Point_Spectrum", "DetectorType": 1, "Name": "Spectrum", "Version": "1.0.0" }, "MeasurementInformation": { "CalibrationCoefficients": [ { "Offset": 0, "Scale": 200000, "Unit": "Nanometer" } ] }, "Tags": { "Aperture": { "CL": { "ApertureHoleString": "0" }, "CL2": { "ApertureHoleString": "0" }, "OL": { "ApertureHoleString": "0" }, "SA": { "ApertureHoleString": "0" } }, "Detector": { "BinningSize": { "X": 2, "Y": 2 }, "DetectorKind": "Test Camera Name 0", "ExposureTimeValue": 123.456, "FrameIntegration": 1, "ImagingArea": { "Height": 512, "Width": 512, "X": 256, "Y": 128 }, "Manufacturer": "Test Vendor", "ModelCode": "Test Camera Name 0", "ModelDisplayName": "Test Camera Name 0", "PixelsPerMeter": { "Horizontal": 200000, "Vertical": 200000 }, "SoftwareBinningSize": { "X": 1, "Y": 1 }, "SoftwareCroppingArea": { "Height": 512, "Width": 512, "X": 0, "Y": 0 } }, "EELS": { "CameraLengthCoefficient": 1, "DataType": "Image", "Dispersion": 0, "DriftTubeVoltage": 0, "EnergyLossOffset": 0, "EntranceApertureHoleString": "Out", "EntranceApertureInserted": False, "FilterMode": "STEM-EELS", "FilterSubmode": "align", "HighTensionOffset": 0, "MagnificationValue": 1, "SectorOffset": 0, "SlitInserted": False, "SlitMode": "Out", "SlitWidth": 0 }, "EOS": { "CameraLength": 0.015, "CameraLengthString": "1.5cm", "ConvergenceAngleAlphaNumber": 0, "ImageFormingMode": "MAG", "MagnificationString": "x20k", "MagnificationValue": 20000, "OperationMode": "Scanning", "RockingAngle": 0, "SpotSizeNumber": 0 }, "General": { "AcquisitionDateTime": "20251216135747868", "AcquisitionId": "93642131-d88c-4016-8390-8f05088a6c2d", "AnalysisDateTime": "20251216135747868", "AnalysisId": "dd22b600-b04b-4675-8c1d-758f7d3e15fc", "Comment": "", "DateTime": "20251216135747873", "Instrument": "JEM-ARM200F", "Manufacturer": "JEOL Ltd.", "ProductName": "FEMTUS", "ProductVersion": "2.0.0.0", "UpdateDateTime": "20251216135747873", "UpdateProductName": "FEMTUS", "UpdateProductVersion": "2.0.0.0" }, "HT": { "AccelerationVoltage": 200000, "EnergyShift": 0, "GunType": "Cfeg" }, "SAAF": { "DPC": { "RotationCorrectionAngle": 0 }, "OBF": { "DefocusMode": "WPOA_zero", "IncidentHalfAngle": 24, "SampleThickness": 10 } }, "ScanGenerator": {}, "Stage": { "PX": { "Position": 0 }, "PY": { "Position": 0 }, "PZ": { "Position": 0 }, "TX": { "Position": 0 }, "TY": { "Position": 0 }, "TZ": { "Position": 0 }, "X": { "Position": 0 }, "Y": { "Position": 0 }, "Z": { "Position": 0 } } } }, "ViewInformation": { "Header": { "ClumpId": "8040c4c1-1bd2-4df8-a449-3eaa92438347", "Version": "2.0.0" }, "Tags": {} } }
- PyJEM.femtus.worksheet.get_clump_num_array(clump_id)¶
Retrieve the NumArray of a clump.
- Parameters:
clump_id (str) – The ID of the clump.
- Returns:
Array shape, type, and memory usage.
Key
Type
Value
Dimensions
list[int]
Shape of the array. Example:
[1, 512].ElementCount
int
Total number of elements in the array.
ElementSize
int
Size of each element in bytes.
ElementType
str
Data type of each element.
IsEdited
bool
Indicates whether the array has been modified.
MemoryLoadableSize
int
Size in bytes required to load the array into memory.
WholeSize
int
Total size of the array in bytes.
- Return type:
dict
Examples
>>> get_clump_num_array('8040c4c1-1bd2-4df8-a449-3eaa92438347') { "Dimensions": [ 1, 512 ], "ElementCount": 512, "ElementSize": 4, "ElementType": "Single", "IsEdited": False, "MemoryLoadableSize": 2048, "WholeSize": 2048 }
- PyJEM.femtus.worksheet.get_clump_num_array_accessor(clump_id)¶
Get the NumArray accessor of a clump.
- Parameters:
clump_id (str) – clump id
- Returns:
The accessor data.
- Return type:
bytes
Examples
>>> arr = get_clump_num_array_accessor("2e8d2104-28cb-47c7-ab19-6970ce0e1774") >>> type(arr) <class 'bytes'>
- PyJEM.femtus.worksheet.put_clump_num_array_accessor(clump_id, chunk)¶
Put the NumArray accessor of a clump.
- Parameters:
clump_id (str) – clump id
chunk (byte) – chunk
- Returns:
The access result
- Return type:
str
Examples
>>> arr = get_clump_num_array_accessor('683d9362-0096-4334-84ef-c426e0818abc') >>> put_clump_num_array_accessor("2e8d2104-28cb-47c7-ab19-6970ce0e1774", arr) 'Success.'
- PyJEM.femtus.worksheet.hide_worksheet_element(worksheet_element_id)¶
Hide a worksheet element.
- Parameters:
worksheet_element_id (str) – The ID of the worksheet element.
- Returns:
dict
- Return type:
A dictionary containing the result.
Examples
>>> hide_worksheet_element('7521de2a-18cf-4d54-8922-e9d282aafa38')
- PyJEM.femtus.worksheet.show_worksheet_element(worksheet_element_id)¶
Show a worksheet element.
- Parameters:
worksheet_element_id (str) – The ID of the worksheet element.
- Returns:
dict
- Return type:
A dictionary containing the result.
Examples
>>> show_worksheet_element('7521de2a-18cf-4d54-8922-e9d282aafa38')