Module ctsimu.scenario.sample

Generic sample: position and orientation, size and material properties.

Classes

class Sample (name: str = '')

Generic sample.

A name can be passed when initializing the sample.

Parameters

name : str
Sample name.
Expand source code 
class Sample(Part):
        """Generic sample."""
        def __init__(self, name:str="", _root=None):
                """A name can be passed when initializing the sample.

                Parameters
                ----------
                name : str
                        Sample name.
                """
                Part.__init__(self, name=name, _root=_root)

                self.set(key="name", value=name, native_unit="string", simple=True)
                self.set(key="file", value=None, native_unit="string")  # surface mesh file

                # Mesh file unit of length:
                self.set(key="unit", value="mm", native_unit="string", simple=True)

                self.new_subgroup("scaling_factor")
                self.scaling_factor.set(key="r", value=1.0, native_unit=None)
                self.scaling_factor.set(key="s", value=1.0, native_unit=None)
                self.scaling_factor.set(key="t", value=1.0, native_unit=None)

                self.set(key="material_id", value=None, native_unit="string", simple=True)

        def set_from_json(self, json_object:dict, stage_coordinate_system:'CoordinateSystem'=None):
                """Import the sample geometry from the JSON sample object.
                The `stage_coordinate_system` must be given as a
                `ctsimu.geometry.CoordinateSystem` object. If this part is not attached
                to the stage, `None` can be passed instead.

                Parameters
                ----------
                json_object : dict
                        A CTSimU sample object, as imported from a JSON structure.

                stage_coordinate_system : CoordinateSystem
                        The stage coordinate system. `None` is also accepted if this part is
                        not attached to the stage.
                """
                self.reset()
                self.set_name(get_value(json_object, ["name"], fail_value="Sample"))

                # Extract the sample's geometry:
                geo = json_extract(json_object, ["position"])
                self.set_geometry(geo, stage_coordinate_system, "sample")

                Group.set_from_json(self, json_object)

        def json_dict(self) -> dict:
                """Create a dictionary of this sample for a CTSimU JSON file.

                Returns
                -------
                json_dict : dict
                        The sample's JSON dictionary.
                """

                jd = Part.json_dict(self)
                jd["position"] = Part.geometry_dict(self)

                return jd

Ancestors

Methods

def json_dict(self) ‑> dict

Create a dictionary of this sample for a CTSimU JSON file.

Returns

json_dict : dict
The sample's JSON dictionary.
def set_from_json(self, json_object: dict, stage_coordinate_system: CoordinateSystem = None)

Import the sample geometry from the JSON sample object. The stage_coordinate_system must be given as a CoordinateSystem object. If this part is not attached to the stage, None can be passed instead.

Parameters

json_object : dict
A CTSimU sample object, as imported from a JSON structure.
stage_coordinate_system : CoordinateSystem
The stage coordinate system. None is also accepted if this part is not attached to the stage.

Inherited members