dara.refine module

dara.refine module#

Perform refinements with BGMN.

pydantic model RefinementPhase[source]#

Bases: BaseModel

Input phase for refinement.

Contains the path to the phase file and the specific parameters for the phase.

Show JSON schema
{
   "title": "RefinementPhase",
   "description": "Input phase for refinement.\n\nContains the path to the phase file and the specific parameters for the phase.",
   "type": "object",
   "properties": {
      "path": {
         "description": "The path to the phase file.",
         "format": "path",
         "title": "Path",
         "type": "string"
      },
      "params": {
         "additionalProperties": true,
         "description": "The specific parameters for the phase.",
         "title": "Params",
         "type": "object"
      }
   },
   "required": [
      "path"
   ]
}

Fields:
Validators:

  • _validate_path » path

field params: dict[str, Any] [Optional]#

The specific parameters for the phase.

field path: Path [Required]#

The path to the phase file.

Validated by:

  • _validate_path

classmethod make(path_obj)[source]#

Make an RefinementPhase object from a path object. If the path object is already an RefinementPhase object, return it. If the path object is a string or Path object, create an RefinementPhase object with the path object with no specific parameters (the default parameters will be used).

Parameters:

path_obj (RefinementPhase | Path | str) – the path object, can be a string, Path object, or RefinementPhase object.

Return type:

RefinementPhase

Returns:

RefinementPhase object

do_refinement(pattern_path, phases, wavelength='Cu', instrument_profile='Aeris-fds-Pixcel1d-Medipix3', working_dir=None, phase_params=None, refinement_params=None, show_progress=False)[source]#

Refine the structure using BGMN.

Return type:

RefinementResult

do_refinement_no_saving(pattern_path, phases, wavelength='Cu', instrument_profile='Aeris-fds-Pixcel1d-Medipix3', phase_params=None, refinement_params=None, show_progress=False)[source]#

Refine the structure using BGMN in a temporary directory without saving.

Return type:

RefinementResult