pymchelper.utils package

Subpackages

• pymchelper.utils.radiotherapy package
  • Submodules
  • pymchelper.utils.radiotherapy.plan module
    • BeamModel
    • Field
      • Field.cum_mu
      • Field.cum_particles
      • Field.diagnose()
      • Field.dose
      • Field.layers
      • Field.n_layers
      • Field.pld_csetweight
      • Field.scaling
      • Field.xmax
      • Field.xmin
      • Field.ymax
      • Field.ymin
    • Layer
      • Layer.cum_mu
      • Layer.cum_particles
      • Layer.energy_measured
      • Layer.energy_nominal
      • Layer.espread
      • Layer.is_empty
      • Layer.mu_to_part_coef
      • Layer.n_spots
      • Layer.repaint
      • Layer.spots
      • Layer.spotsize
      • Layer.xmax
      • Layer.xmin
      • Layer.ymax
      • Layer.ymin
    • Plan
      • Plan.apply_beammodel()
      • Plan.beam_model
      • Plan.beam_name
      • Plan.diagnose()
      • Plan.export()
      • Plan.factor
      • Plan.fields
      • Plan.flip_x
      • Plan.flip_xy
      • Plan.flip_y
      • Plan.n_fields
      • Plan.patient_firstname
      • Plan.patient_id
      • Plan.patient_initals
      • Plan.patient_name
      • Plan.plan_date
      • Plan.plan_label
      • Plan.scaling
    • dedx_air()
    • load()
    • load_DICOM_VARIAN()
    • load_PLD_IBA()
    • load_RASTER_GSI()
    • main()
  • Module contents

Submodules

pymchelper.utils.mcscripter module

Tool for creating MC input files using user-specified tables and ranges.

2019 - Niels Bassler

class pymchelper.utils.mcscripter.Config(const_dict: ~typing.Dict[str, str] = <factory>, table_dict: ~typing.Dict[str, ~typing.List[str]] = <factory>, path: ~pathlib.Path = <factory>, files: ~typing.List[str] = <factory>, symlinks: ~typing.List[str] = <factory>)

Bases: object

Description needed.

const_dict: Dict[str, str]

files: List[str]

path: Path

symlinks: List[str]

table_dict: Dict[str, List[str]]

class pymchelper.utils.mcscripter.McFile(path: ~pathlib.Path = <factory>, symlink: bool = False, lines: ~typing.List[str] = <factory>)

Bases: object

General MC single file object. This will be used for the template files as well as the generated output files.

property fname

Description needed

lines: List[str]

path: Path

read()

Description needed

symlink: bool = False

write()

Description needed

class pymchelper.utils.mcscripter.Template(files: ~typing.List[~pymchelper.utils.mcscripter.McFile] = <factory>)

Bases: object

Description needed.

files: List[McFile]

static prepare(cfg: Config) → Generator

Description needed.

write(working_directory: PathLike, cfg: Config, quiet: bool = True)

Description needed.

pymchelper.utils.mcscripter.lreplace(text: str, old: str, new: str) → str

Left adjusted replacement of string f with string r, in string s.

This function is implemented in order to fill in data in FORTRAN77 fields, which are tied to certain positions on the line, i.e. subsequent values may not be shifted.

Finds string f in string s and replaces it with string r, but left adjusted, retaining line length. If length of r is shorter than length of f, remaining chars will be space padded. If length of r is larger than length of f, then characters will be overwritten. A copy of s with the replacement is returned.

pymchelper.utils.mcscripter.main(args=None)

Main function.

pymchelper.utils.mcscripter.read_config(path: PathLike, quiet: bool = True) → Config

Description needed

pymchelper.utils.mcscripter.read_template(cfg: Config) → Template

Description needed.

pymchelper.utils.runmc module

pymchelper.utils.runmc.main(args=None)

Entry point to the runmc script: argument parsing and calling run method

pymchelper.utils.runmc.set_logger_level(args)

Set logger verbosity and quietness based on parsed arguments Checks for presence of quiet (-q) and verbose (-v) switches

Module contents