Specimen

Conditions defining a physical specimen.

Helper classes

class pyhmsa.spec.condition.specimen.SpecimenLayer(name=None, thickness=None, formula=None, composition=None)

Defines a layer of a multi-layered specimen.

Parameters:

• name – name (optional)
• thickness – thickness, bulk layer if None (optional)
• formula – formula
• composition – composition

composition

composition

formula

formula

get_composition(instance)

get_formula(instance)

get_name(instance)

get_thickness(instance)

is_bulk()

Returns whether this layer is a bulk layer.

name

name

set_composition(instance, value)

set_formula(instance, value)

set_name(instance, value)

set_thickness(instance, value, unit=None)

thickness

thickness

Classes

class pyhmsa.spec.condition.specimen.Specimen(name, description=None, origin=None, formula=None, composition=None, temperature=None)

Defines a physical specimen, including the name, origin, composition, etc.

Parameters:

• name – name (required)
• description – description (optional)
• origin – origin (optional)
• formula – formula (optional)
• composition – composition (optional)
• temperature – temperature (optional)

CLASS = None

TEMPLATE = 'Specimen'

composition

composition

description

description

formula

formula

get_composition(instance)

get_description(instance)

get_formula(instance)

get_name(instance)

get_origin(instance)

get_temperature(instance)

name

name

origin

origin

set_composition(instance, value)

set_description(instance, value)

set_formula(instance, value)

set_name(instance, value)

set_origin(instance, value)

set_temperature(instance, value, unit=None)

temperature

temperature

class pyhmsa.spec.condition.specimen.SpecimenMultilayer(name, description=None, origin=None, formula=None, composition=None, temperature=None, layers=None)

Defines a multi-layered physical specimen

Parameters:

• name – name (required)
• description – description (optional)
• origin – origin (optional)
• formula – formula (optional)
• composition – composition (optional)
• temperature – temperature (optional)
• layers – layers (optional)

CLASS = 'Multilayer'

TEMPLATE = 'Specimen'

append_layer(name=None, thickness=None, formula=None, composition=None)

Utility function to create a layer.

Parameters:

• name – name (optional)
• thickness – thickness, bulk layer if None (optional)
• formula – formula
• composition – composition

Returns:

created layer

Return type:

SpecimenLayer

composition

composition

description

description

formula

formula

get_composition(instance)

get_description(instance)

get_formula(instance)

get_layers(instance)

get_name(instance)

get_origin(instance)

get_temperature(instance)

layers

modifiable list of layers

name

name

origin

origin

set_composition(instance, value)

set_description(instance, value)

set_formula(instance, value)

set_name(instance, value)

set_origin(instance, value)

set_temperature(instance, value, unit=None)

temperature

temperature