portpy package

Subpackages

• portpy.photon package
  • Subpackages
    • portpy.photon.utils package
      • Submodules
      • portpy.photon.utils.load_data module
      • portpy.photon.utils.load_metadata module
      • portpy.photon.utils.save_nrrd module
      • portpy.photon.utils.save_or_load_pickle module
      • portpy.photon.utils.slicer_script module
      • portpy.photon.utils.sol_change_inf_matrix module
      • portpy.photon.utils.view_in_slicer_jupyter module
      • Module contents
  • Submodules
  • portpy.photon.beam module
    • Beams
      • Beams.create_beamlet_idx_2d_grid()
      • Beams.get_all_beam_ids()
      • Beams.get_beamlet_height()
      • Beams.get_beamlet_idx_2dgrid()
      • Beams.get_beamlet_width()
      • Beams.get_collimator_angle()
      • Beams.get_gantry_angle()
      • Beams.get_original_map()
      • Beams.preprocess_beams()
      • Beams.sort_beamlets()
  • portpy.photon.clinical_criteria module
    • ClinicalCriteria
      • ClinicalCriteria.add_criterion()
      • ClinicalCriteria.create_criterion()
      • ClinicalCriteria.get_criteria()
      • ClinicalCriteria.modify_criterion()
  • portpy.photon.cvxpy_prob module
    • CvxPyProb
      • CvxPyProb.add_boo()
      • CvxPyProb.add_constraints()
      • CvxPyProb.add_dvh()
      • CvxPyProb.add_max()
      • CvxPyProb.add_mean()
      • CvxPyProb.add_objective()
      • CvxPyProb.add_overdose_quad()
      • CvxPyProb.add_quad()
      • CvxPyProb.add_smoothness_quad()
      • CvxPyProb.add_underdose_quad()
      • CvxPyProb.get_smoothness_matrix()
      • CvxPyProb.get_sol()
      • CvxPyProb.matching_keys()
      • CvxPyProb.solve()
  • portpy.photon.evaluation module
    • Evaluation
      • Evaluation.get_dose()
      • Evaluation.get_dvh()
      • Evaluation.get_max_dose()
      • Evaluation.get_mean_dose()
      • Evaluation.get_volume()
  • portpy.photon.influence_matrix module
    • InfluenceMatrix
      • InfluenceMatrix.create_BEV_mask_from_contours()
      • InfluenceMatrix.create_beamlet_idx_2d_grid()
      • InfluenceMatrix.dose_1d_to_3d()
      • InfluenceMatrix.dose_3d_to_1d()
      • InfluenceMatrix.down_sample_2d_grid()
      • InfluenceMatrix.down_sample_voxels()
      • InfluenceMatrix.fluence_1d_to_2d()
      • InfluenceMatrix.fluence_2d_to_1d()
      • InfluenceMatrix.get_all_beam_ids()
      • InfluenceMatrix.get_beamlet_info()
      • InfluenceMatrix.get_bev_2d_grid()
      • InfluenceMatrix.get_influence_matrix()
      • InfluenceMatrix.get_opt_voxels_idx()
      • InfluenceMatrix.get_opt_voxels_size()
      • InfluenceMatrix.get_orig_res_2d_grid()
      • InfluenceMatrix.get_voxel_info()
      • InfluenceMatrix.plot_fluence_2d()
      • InfluenceMatrix.plot_fluence_3d()
      • InfluenceMatrix.pre_process_voxels()
      • InfluenceMatrix.preprocess_beams()
      • InfluenceMatrix.set_opt_voxel_idx()
      • InfluenceMatrix.sort_beamlets()
      • InfluenceMatrix.surface_plot()
  • portpy.photon.optimization module
    • Optimization
      • Optimization.create_rinds()
      • Optimization.get_smoothness_matrix()
      • Optimization.matching_keys()
      • Optimization.run_IMRT_fluence_map_CVXPy()
      • Optimization.run_IMRT_fluence_map_CVXPy_BOO_benchmark()
      • Optimization.run_IMRT_fluence_map_CVXPy_dvh_benchmark()
      • Optimization.set_rinds_opt_voxel_idx()
  • portpy.photon.plan module
    • Plan
      • Plan.add_rinds()
      • Plan.create_inf_matrix()
      • Plan.get_ct_res_xyz_mm()
      • Plan.get_disease_site()
      • Plan.get_num_of_fractions()
      • Plan.get_plan_beams()
      • Plan.get_prescription()
      • Plan.load_optimal_sol()
      • Plan.load_plan()
      • Plan.plot_dvh()
      • Plan.plot_fluence_2d()
      • Plan.plot_fluence_3d()
      • Plan.run_IMRT_fluence_map_CVXPy()
      • Plan.save_nrrd()
      • Plan.save_optimal_sol()
      • Plan.save_plan()
      • Plan.view_in_slicer()
  • portpy.photon.structures module
    • Structures
      • Structures.create_structure()
      • Structures.delete_structure()
      • Structures.expand()
      • Structures.get_fraction_of_vol_in_calc_box()
      • Structures.get_structures()
      • Structures.get_volume_cc()
      • Structures.intersect()
      • Structures.modify_structure()
      • Structures.preprocess_structures()
      • Structures.shrink()
      • Structures.subtract()
      • Structures.union()
  • portpy.photon.visualization module
    • Visualization
      • Visualization.display_patient_metadata()
      • Visualization.display_patients()
      • Visualization.dose_type
      • Visualization.get_cmap_colors()
      • Visualization.get_colors()
      • Visualization.is_notebook()
      • Visualization.legend_dose_storage()
      • Visualization.plan_metrics()
      • Visualization.plot_2d_dose()
      • Visualization.plot_binary_mask_points()
      • Visualization.plot_dvh()
      • Visualization.plot_fluence_2d()
      • Visualization.plot_fluence_3d()
      • Visualization.plot_robust_dvh()
      • Visualization.surface_plot()
      • Visualization.view_in_slicer()
      • Visualization.view_in_slicer_jupyter()
      • Visualization.volume_type
  • Module contents

Module contents