PyJEM.eels.sicube

PyJEM.eels.sicube.create_count_map(dataset_id)

Create a count map 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 maps.

Return type:

dict

Examples

>>> create_count_map("79be5de1-f506-493e-b88f-a1e717e1d345")
{
    "Ids": [
        "51ca33ce-1374-49e7-81a1-33205b86b544",
        "aaa6cb42-d848-4efb-b9d6-5d5bbbabc0ec",
        "4410fbc1-8b76-42e6-ac86-66a465414275"
    ]
}

PyJEM.eels.sicube.create_quantitative_map(dataset_id, param)

Create a quantitative map 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 map 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 UUIDs representing the created quantitative maps.

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_map("79be5de1-f506-493e-b88f-a1e717e1d345", param)
{
    "Ids": [
        "51ca33ce-1374-49e7-81a1-33205b86b544",
        "bab6a8c4-3079-4732-9a1a-343c64be3032",
        "37af8d66-2828-400d-ac9e-8120991ddcf4"
    ]
}

PyJEM.eels.sicube.create_thickness_map(dataset_id)

Create a thickness map 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 maps.

Return type:

dict

Examples

>>> create_thickness_map("79be5de1-f506-493e-b88f-a1e717e1d345")
{
    "Ids": [
        "51ca33ce-1374-49e7-81a1-33205b86b544",
        "09e49775-58d6-4878-b03a-751ccb4c0338"
    ]
}

PyJEM.eels.sicube.create_si_cube_whole_spectrum(dataset_id)

Create a 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 worksheet element representing the created spectrum cubes. - [0] = Image content - [1] = Graph content

Return type:

dict

Examples

>>> create_si_cube_whole_spectrum("61a503b1-5f3a-4604-a1f3-303aede9ad49")
{
    "Ids": [
        "6b867b00-2c90-4f04-89c7-c4c9655b7b8d",
        "24684514-f89d-42fe-902c-62fb63b64b63"
    ]
}

PyJEM.eels.sicube.select_chemical_elements(dataset_id, param)

Select chemical elements 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) –

  Chemical element selection parameters.

  key	type	value
  ChemicalElements	list[dict]	List of chemical element entries. ⇒ See ChemicalElement items.

  ChemicalElement items

  key	type	value
  AtomicNumber	int	Atomic number of the element. Example: 5
  ElectronShell	str	Electron shell designation. Example: "K"

Return type:

None

Examples

>>> param = {
...     "ChemicalElements": [
...         {
...             "AtomicNumber": 5,
...             "ElectronShell": "K"
...         },
...         {
...             "AtomicNumber": 1,
...             "ElectronShell": "K"
...         }
...     ]
... }
>>> select_chemical_elements("15b7caa0-88ed-4062-b52a-1de2699f8363", param)

PyJEM.eels.sicube.get_chemical_elements(dataset_id)

Get chemical elements 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
ChemicalElements	list[dict]	List of chemical element entries. ⇒ See ChemicalElement items.

ChemicalElement items

key	type	value
AtomicNumber	int	Atomic number of the element. Example: 5
ElectronShell	str	Electron shell designation. Example: "K"

Return type:

dict

Examples

>>> get_chemical_elements("15b7caa0-88ed-4062-b52a-1de2699f8363")
{
    "ChemicalElements": [
        {
            "AtomicNumber": 5,
            "ElectronShell": "K"
        },
        {
            "AtomicNumber": 1,
            "ElectronShell": "K"
        }
    ]
}