PyJEM.eels.line

PyJEM.eels.line.create_count_line(dataset_id)

Create a count line for the given target graph data set ID.

Parameters:

dataset_id (str) – The ID of the target graph data set. Must be a valid GUID string.

Returns:

The returned value is a dictionary. A description of each item is provided below.

key

type

value

Ids

list[str]

List of UUIDs representing the created count line segments.

Return type:

dict

Examples

>>> create_count_line("741472dd-a29a-43f5-b1bc-aecf4f4fe6ab")
{
    "Ids": [
        "c38434ff-20f9-4f8d-88ac-3e3792d06209",
        "996102c7-8101-4e67-bb4c-0b37a33a8e74"
    ]
}
PyJEM.eels.line.create_quantitative_line(dataset_id, param)

Create a quantitative line for the given target graph data set ID.

Parameters:
  • dataset_id (str) – The ID of the target graph data set. Must be a valid GUID string.

  • param (dict) –

    Quantitative line creation parameters.

    key

    type

    value

    Config

    dict

    Configuration parameters.

    ⇒ See Config items.

    Config items

    key

    type

    value

    AccelarationVoltage

    float

    Acceleration voltage value.

    Example:

    1

    CoreLossCrossSection

    int

    Core loss cross section value.

    Example:

    0

    CorrectionAngle

    float

    Correction angle value.

    Example:

    1

    IsUseZlp

    bool

    Whether to use zero-loss peak.

    Example:

    False

    Spectrum

    dict

    Spectrum selection parameters.

    ⇒ See Spectrum items.

    Spectrum items

    key

    type

    value

    Mode

    str

    Analysis mode. One of "SameSpectrum" or "AnotherSpectrum".

    Example:

    "SameSpectrum"

    Spectrum

    str

    Spectrum ID (GUID string).

    Example:

    "15b7caa0-88ed-4062-b52a-1de2699f8363"

Returns:

The returned value is a dictionary. A description of each item is provided below.

key

type

value

Ids

list[str]

List of unique identifier strings representing the created quantitative lines.

Return type:

dict

Examples

>>> param = {
...     "Config": {
...         "AccelarationVoltage": 1,
...         "CoreLossCrossSection": 0,
...         "CorrectionAngle": 1,
...         "IsUseZlp": False,
...         "Spectrum": {
...             "Mode": "SameSpectrum",
...             "Spectrum": "15b7caa0-88ed-4062-b52a-1de2699f8363"
...         }
...     }
... }
>>> create_quantitative_line("00000000-0000-0000-0000-000000000000", param)
{
    "Ids": [
        "c38434ff-20f9-4f8d-88ac-3e3792d06209",
        "730b6e97-ca6a-454e-bc43-6013cddc84f9"
    ]
}
PyJEM.eels.line.create_thickness_line(dataset_id)

Create a thickness line for the given target graph data set ID.

Parameters:

dataset_id (str) – The ID of the target graph data set. Must be a valid GUID string.

Returns:

The returned value is a dictionary. A description of each item is provided below.

key

type

value

Ids

list[str]

List of UUIDs representing the created thickness line segments.

Return type:

dict

Examples

>>> create_thickness_line("00000000-0000-0000-0000-000000000000")
{
    "Ids": [
        "c38434ff-20f9-4f8d-88ac-3e3792d06209",
        "8c7c56dc-9df3-40b8-8f4d-a1a19d03b3ae"
    ]
}
PyJEM.eels.line.create_line_whole_spectrum(dataset_id)

Create a line whole spectrum for the given target image data set ID.

Parameters:

dataset_id (str) – The ID of the target graph data set. Must be a valid GUID string.

Returns:

The returned value is a dictionary. A description of each item is provided below.

key

type

value

Ids

list[str]

List of UUIDs representing the created spectrum line segments.

Return type:

dict

Examples

>>> create_line_whole_spectrum("61a503b1-5f3a-4604-a1f3-303aede9ad49")
{
    "Ids": [
        "6b867b00-2c90-4f04-89c7-c4c9655b7b8d",
        "11844c1f-51e5-414f-a4c6-412638577728"
    ]
}