Skip to main content
Back to top
Ctrl
+
K
User Guide
API Reference
Development
About
More
Plopp
Sciline
Scipp
ScippNeutron
ScippNexus
System Settings
Light
Dark
GitHub
PyPI
Conda
User Guide
API Reference
Development
About
Plopp
Sciline
Scipp
ScippNeutron
ScippNexus
System Settings
Light
Dark
GitHub
PyPI
Conda
Section Navigation
ess.reflectometry.providers
ess.reflectometry.batch_compute
ess.reflectometry.batch_processor
ess.reflectometry.scale_for_reflectivity_overlap
ess.reflectometry.orso
ess.reflectometry.orso.OrsoCreator
ess.reflectometry.orso.OrsoDataSource
ess.reflectometry.orso.OrsoExperiment
ess.reflectometry.orso.OrsoInstrument
ess.reflectometry.orso.OrsoIofQDataset
ess.reflectometry.orso.OrsoMeasurement
ess.reflectometry.orso.OrsoOwner
ess.reflectometry.orso.OrsoReduction
ess.reflectometry.orso.OrsoSample
ess.reflectometry.orso.OrsoSampleFilenames
ess.reflectometry.orso.build_orso_data_source
ess.reflectometry.orso.build_orso_instrument
ess.reflectometry.orso.build_orso_iofq_dataset
ess.reflectometry.orso.build_orso_measurement
ess.reflectometry.orso.build_orso_reduction
ess.reflectometry.orso.orso_data_files
ess.reflectometry.orso.parse_orso_experiment
ess.reflectometry.orso.parse_orso_owner
ess.reflectometry.orso.parse_orso_sample
ess.reflectometry.supermirror
ess.reflectometry.supermirror.supermirror_reflectivity
ess.reflectometry.supermirror.types
ess.reflectometry.supermirror.types.MValue
ess.reflectometry.supermirror.types.CriticalEdge
ess.reflectometry.supermirror.types.Alpha
ess.reflectometry.types
ess.reflectometry.types.ReducedReference
ess.reflectometry.types.Reference
ess.reflectometry.types.Sample
ess.reflectometry.types.ReflectivityOverQ
ess.reflectometry.types.ReflectivityOverZW
ess.reflectometry.types.QResolution
ess.reflectometry.types.QBins
ess.reflectometry.types.WavelengthBins
ess.reflectometry.types.DetectorSpatialResolution
ess.reflectometry.types.YIndexLimits
ess.reflectometry.types.ZIndexLimits
ess.reflectometry.types.BeamDivergenceLimits
ess.reflectometry.types.ReferenceFilePath
ess.reflectometry.types.BeamSize
ess.reflectometry.types.CoordTransformationGraph
ess.reflectometry.types.CorrectedDetector
ess.reflectometry.types.DetectorRotation
ess.reflectometry.types.RawChopper
ess.reflectometry.types.RawSampleRotation
ess.reflectometry.types.ReducibleData
ess.reflectometry.types.SampleRotation
ess.reflectometry.types.SampleRotationOffset
ess.reflectometry.types.SampleSize
ess.reflectometry.types.ThetaBins
ess.reflectometry.tools
ess.reflectometry.tools.batch_compute
ess.reflectometry.tools.batch_processor
ess.reflectometry.tools.combine_curves
ess.reflectometry.tools.fwhm_to_std
ess.reflectometry.tools.linlogspace
ess.reflectometry.tools.scale_for_reflectivity_overlap
ess.reflectometry.tools.smooth_with_resolution
ess.reflectometry.tools.BatchProcessor
ess.reflectometry.tools.MultiGraphViz
ess.reflectometry.workflow
ess.reflectometry.workflow.with_filenames
ess.reflectometry.figures
ess.reflectometry.figures.diagnostic_view
ess.reflectometry.figures.q_theta_diagnostic_figure
ess.reflectometry.figures.q_theta_figure
ess.reflectometry.figures.wavelength_theta_diagnostic_figure
ess.reflectometry.figures.wavelength_theta_figure
ess.reflectometry.figures.wavelength_z_diagnostic_figure
ess.reflectometry.figures.wavelength_z_figure
ess.amor.conversions
ess.amor.conversions.add_coords
ess.amor.conversions.add_masks
ess.amor.conversions.coordinate_transformation_graph
ess.amor.conversions.divergence_angle
ess.amor.conversions.theta
ess.amor.conversions.theta_no_gravity
ess.amor.conversions.wavelength
ess.amor.data
ess.amor.data.amor_old_reference_run
ess.amor.data.amor_old_sample_run
ess.amor.data.amor_psi_software_result
ess.amor.data.amor_run
ess.amor.load
ess.amor.load.amor_chopper
ess.amor.load.load_amor_ch_frequency
ess.amor.load.load_amor_ch_phase
ess.amor.load.load_amor_chopper_distance
ess.amor.load.load_amor_chopper_separation
ess.amor.load.load_amor_detector_rotation
ess.amor.load.load_amor_proton_charge
ess.amor.load.load_amor_sample_rotation
ess.amor.load.load_beamline_metadata
ess.amor.load.load_detector
ess.amor.load.load_events
ess.amor.load.load_measurement_metadata
ess.amor.orso
ess.amor.orso.orso_amor_corrections
ess.amor.resolution
ess.amor.resolution.angular_resolution
ess.amor.resolution.q_resolution
ess.amor.resolution.sample_size_resolution
ess.amor.resolution.wavelength_resolution
ess.amor.types
ess.amor.types.ChopperDistance
ess.amor.types.ChopperFrequency
ess.amor.types.ChopperPhase
ess.amor.types.ChopperSeparation
ess.amor.utils
ess.amor.utils.qgrid
ess.amor.utils.theta_grid
ess.amor.normalization
ess.amor.normalization.evaluate_reference_at_sample_coords
ess.amor.normalization.mask_events_where_supermirror_does_not_cover
ess.amor.workflow
ess.amor.workflow.add_coords_masks_and_apply_corrections
ess.estia.conversions
ess.estia.conversions.add_coords
ess.estia.conversions.coordinate_transformation_graph
ess.estia.conversions.divergence_angle
ess.estia.conversions.reflectometry_q_x
ess.estia.conversions.theta
ess.estia.maskings
ess.estia.maskings.add_masks
ess.estia.corrections
ess.estia.corrections.add_coords_masks_and_apply_corrections
ess.estia.corrections.assume_time_series_constant_with_zero_default_value_if_empty
ess.estia.corrections.correct_by_footprint
ess.estia.corrections.insert_run_normalization
ess.estia.corrections.normalize_by_monitor_histogram
ess.estia.corrections.normalize_by_monitor_integrated
ess.estia.data
ess.estia.data.estia_mcstas_groundtruth
ess.estia.data.estia_mcstas_nexus_reference_example
ess.estia.data.estia_mcstas_nexus_sample_example
ess.estia.data.estia_mcstas_reference_example
ess.estia.data.estia_mcstas_reference_run
ess.estia.data.estia_mcstas_sample_example
ess.estia.data.estia_mcstas_sample_run
ess.estia.data.estia_mcstas_spin_flip_example
ess.estia.data.estia_mcstas_spin_flip_example_download_all_to_cache
ess.estia.data.estia_mcstas_spin_flip_example_groundtruth
ess.estia.data.estia_wavelength_lookup_table
ess.estia.mcstas
ess.estia.mcstas.detector_ltotal_from_raw
ess.estia.mcstas.load_detector_rotation
ess.estia.mcstas.load_mcstas
ess.estia.mcstas.load_mcstas_provider
ess.estia.mcstas.load_sample_position
ess.estia.mcstas.load_sample_rotation
ess.estia.mcstas.load_source_position
ess.estia.mcstas.parse_events_ascii
ess.estia.mcstas.parse_events_h5
ess.estia.mcstas.parse_metadata_ascii
ess.estia.mcstas.use_mcstas_wavelengths_instead_of_estimates_from_time_of_arrival
ess.estia.load
ess.estia.load.load_detector_rotation
ess.estia.load.load_sample_rotation
ess.estia.resolution
ess.estia.resolution.angular_resolution
ess.estia.resolution.q_resolution
ess.estia.resolution.sample_size_resolution
ess.estia.resolution.wavelength_resolution
ess.estia.types
ess.estia.types.BeamMonitor
ess.estia.normalization
ess.estia.normalization.evaluate_reference
ess.estia.normalization.mask_events_where_supermirror_does_not_cover
ess.estia.workflow
ess.estia.workflow.mcstas_providers
ess.estia.workflow.providers
ess.estia.workflow.EstiaMcStasMonitorHistogramWorkflow
ess.estia.workflow.EstiaMcStasMonitorIntegratedWorkflow
ess.estia.workflow.EstiaMcStasProtonChargeWorkflow
ess.estia.workflow.EstiaMcStasUnnormalizedWorkflow
ess.estia.workflow.EstiaMcStasWorkflow
ess.estia.workflow.EstiaMonitorHistogramWorkflow
ess.estia.workflow.EstiaMonitorIntegratedWorkflow
ess.estia.workflow.EstiaProtonChargeWorkflow
ess.estia.workflow.EstiaUnnormalizedWorkflow
ess.estia.workflow.EstiaWorkflow
ess.estia.workflow.default_parameters
ess.estia.workflow.mcstas_default_parameters
ess.freia.conversions
ess.freia.conversions.assign_incident_angle
ess.freia.conversions.assign_incident_angle_from_shutter_logs
ess.freia.conversions.closest_beam_incident_angle_graph
ess.freia.conversions.coordinate_transformation_graph
ess.freia.conversions.fixed_slits_incident_angle_graph
ess.freia.conversions.incident_angle
ess.freia.conversions.incident_beam_directions
ess.freia.conversions.offspecular_coordinate_transformation_graph
ess.freia.conversions.outgoing_direction
ess.freia.conversions.sample_coordinate_transformation_graph
ess.freia.conversions.scattering_angle
ess.freia.conversions.shutter_log_incident_angle_graph
ess.freia.conversions.theta
ess.freia.conversions.time_at_detector
ess.freia.conversions.time_at_shutter
ess.freia.maskings
ess.freia.maskings.add_roi_masks
ess.freia.corrections
ess.freia.corrections.add_offspecular_coords_and_masks
ess.freia.corrections.add_reference_coords_and_masks
ess.freia.corrections.add_sample_coords_and_masks
ess.freia.corrections.correct_sample
ess.freia.corrections.insert_run_normalization
ess.freia.corrections.normalize_by_monitor_histogram
ess.freia.corrections.normalize_by_monitor_integrated
ess.freia.data
ess.freia.data.freia_mcstas_reference_run
ess.freia.data.freia_mcstas_sample_run
ess.freia.data.freia_mcstas_silicon_reflectivity
ess.freia.data.freia_wavelength_lookup_table_no_choppers
ess.freia.mcstas
ess.freia.mcstas.load_mcstas
ess.freia.mcstas.load_mcstas_monitor
ess.freia.mcstas.load_mcstas_provider
ess.freia.mcstas.mcstas_detector_geometry
ess.freia.mcstas.mcstas_sample_position
ess.freia.mcstas.mcstas_sample_surface_normal
ess.freia.mcstas.mcstas_source_position
ess.freia.mcstas.mcstas_wavelength_monitor
ess.freia.mcstas.non_wfm_choppers
ess.freia.mcstas.wfm_choppers
ess.freia.resolution
ess.freia.resolution.angular_resolution
ess.freia.resolution.q_resolution
ess.freia.resolution.sample_size_resolution
ess.freia.resolution.wavelength_resolution
ess.freia.types
ess.freia.types.WBC1Monitor
ess.freia.types.PSCMonitor
ess.freia.types.WBC2Monitor
ess.freia.types.WBC3Monitor
ess.freia.types.ShutterMonitor
ess.freia.types.NormalizationMonitor
ess.freia.types.DetectorRegionOfInterest
ess.freia.types.DownstreamSlitCenters
ess.freia.types.IncidentAngleGraph
ess.freia.types.SampleSurfaceNormal
ess.freia.types.ShutterPositions
ess.freia.types.ShutterStatusLogs
ess.freia.types.UpstreamSlitCenters
ess.freia.normalization
ess.freia.normalization.evaluate_direct_beam
ess.freia.normalization.reduce_sample_over_q
ess.freia.workflow
ess.freia.workflow.providers
ess.freia.workflow.FreiaMcStasMonitorHistogramWorkflow
ess.freia.workflow.FreiaMcStasMonitorIntegratedWorkflow
ess.freia.workflow.FreiaMcStasProtonChargeWorkflow
ess.freia.workflow.FreiaMcStasUnnormalizedWorkflow
ess.freia.workflow.FreiaMcStasWorkflow
ess.freia.workflow.FreiaMonitorHistogramWorkflow
ess.freia.workflow.FreiaMonitorIntegratedWorkflow
ess.freia.workflow.FreiaOffspecWorkflow
ess.freia.workflow.FreiaProtonChargeWorkflow
ess.freia.workflow.FreiaUnnormalizedWorkflow
ess.freia.workflow.FreiaWorkflow
ess.freia.workflow.default_parameters
ess.freia.workflow.mcstas_default_parameters
ess.offspec.conversions
ess.offspec.conversions.coordinate_transformation_graph_reference
ess.offspec.conversions.coordinate_transformation_graph_sample
ess.offspec.data
ess.offspec.data.offspec_direct_beam_run
ess.offspec.data.offspec_sample_run
ess.offspec.load
ess.offspec.load.load_offspec_events
ess.offspec.load.load_offspec_monitor
ess.offspec.normalization
ess.offspec.normalization.evaluate_reference
ess.offspec.normalization.evaluate_sample
ess.offspec.types
ess.offspec.types.MonitorData
ess.offspec.workflow
ess.offspec.workflow.OffspecWorkflow
ess.offspec.workflow.add_coords_masks_and_apply_corrections
Show Source
API Reference
ess.freia.maskings
ess.freia.maskings
#
Functions
add_roi_masks
(da, roi)
Mask events outside the ROI.
