Skip to main content
Ctrl+K
ESSnmx - Home ESSnmx - Home
  • User Guide
  • API Reference
  • Development
  • About
    • Plopp
    • Sciline
    • Scipp
    • ScippNexus
  • GitHub
  • PyPI
  • Conda
  • User Guide
  • API Reference
  • Development
  • About
  • Plopp
  • Sciline
  • Scipp
  • ScippNexus
  • GitHub
  • PyPI
  • Conda

Section Navigation

  • ess.nmx.data
    • ess.nmx.data.get_path
    • ess.nmx.data.get_small_mcstas
    • ess.nmx.data.get_small_mtz_samples
    • ess.nmx.data.get_small_nmx_nexus
    • ess.nmx.data.get_small_random_mtz_samples
  • ess.nmx.mcstas
    • ess.nmx.mcstas.NMXMcStasWorkflow
    • ess.nmx.mcstas.executables
      • ess.nmx.mcstas.executables.build_reduction_arg_parser
      • ess.nmx.mcstas.executables.calculate_raw_data_metadata
      • ess.nmx.mcstas.executables.main
      • ess.nmx.mcstas.executables.reduction
    • ess.nmx.mcstas.load
      • ess.nmx.mcstas.load.bank_names_to_detector_names
      • ess.nmx.mcstas.load.detector_name_from_index
      • ess.nmx.mcstas.load.load_crystal_rotation
      • ess.nmx.mcstas.load.load_detector_metadata
      • ess.nmx.mcstas.load.load_event_data_bank_name
      • ess.nmx.mcstas.load.load_experiment_metadata
      • ess.nmx.mcstas.load.load_mcstas
      • ess.nmx.mcstas.load.load_raw_event_data
      • ess.nmx.mcstas.load.maximum_probability
      • ess.nmx.mcstas.load.mcstas_weight_to_probability_scalefactor
      • ess.nmx.mcstas.load.raw_event_data_chunk_generator
      • ess.nmx.mcstas.load.retrieve_pixel_ids
      • ess.nmx.mcstas.load.retrieve_raw_data_metadata
    • ess.nmx.mcstas.nexus
      • ess.nmx.mcstas.nexus.export_as_nexus
      • ess.nmx.mcstas.nexus.NXLauetofWriter
    • ess.nmx.mcstas.reduction
      • ess.nmx.mcstas.reduction.calculate_maximum_toa
      • ess.nmx.mcstas.reduction.calculate_minimum_toa
      • ess.nmx.mcstas.reduction.format_nmx_reduced_data
      • ess.nmx.mcstas.reduction.merge_panels
      • ess.nmx.mcstas.reduction.proton_charge_from_event_counts
      • ess.nmx.mcstas.reduction.raw_event_probability_to_counts
      • ess.nmx.mcstas.reduction.reduce_raw_event_probability
    • ess.nmx.mcstas.streaming
      • ess.nmx.mcstas.streaming.calculate_number_of_chunks
      • ess.nmx.mcstas.streaming.MaxAccumulator
      • ess.nmx.mcstas.streaming.MinAccumulator
    • ess.nmx.mcstas.types
      • ess.nmx.mcstas.types.FilePath
      • ess.nmx.mcstas.types.DetectorIndex
      • ess.nmx.mcstas.types.DetectorName
      • ess.nmx.mcstas.types.DetectorBankPrefix
      • ess.nmx.mcstas.types.MaximumCounts
      • ess.nmx.mcstas.types.MaximumProbability
      • ess.nmx.mcstas.types.McStasWeight2CountScaleFactor
      • ess.nmx.mcstas.types.NMXExperimentMetadata
      • ess.nmx.mcstas.types.NMXDetectorMetadata
      • ess.nmx.mcstas.types.RawEventProbability
      • ess.nmx.mcstas.types.NMXRawEventCountsDataGroup
      • ess.nmx.mcstas.types.ProtonCharge
      • ess.nmx.mcstas.types.CrystalRotation
      • ess.nmx.mcstas.types.DetectorGeometry
      • ess.nmx.mcstas.types.TimeBinSteps
      • ess.nmx.mcstas.types.PixelIds
      • ess.nmx.mcstas.types.NMXReducedProbability
      • ess.nmx.mcstas.types.NMXReducedCounts
      • ess.nmx.mcstas.types.NMXReducedDataGroup
      • ess.nmx.mcstas.types.MinimumTimeOfArrival
      • ess.nmx.mcstas.types.MaximumTimeOfArrival
      • ess.nmx.mcstas.types.NMXRawDataMetadata
    • ess.nmx.mcstas.xml
      • ess.nmx.mcstas.xml.filter_by_tag
      • ess.nmx.mcstas.xml.filter_by_type_prefix
      • ess.nmx.mcstas.xml.find_attributes
      • ess.nmx.mcstas.xml.read_mcstas_geometry_xml
      • ess.nmx.mcstas.xml.select_by_tag
      • ess.nmx.mcstas.xml.select_by_type_prefix
      • ess.nmx.mcstas.xml.DetectorDesc
      • ess.nmx.mcstas.xml.McStasInstrument
      • ess.nmx.mcstas.xml.SampleDesc
      • ess.nmx.mcstas.xml.SimulationSettings
      • ess.nmx.mcstas.xml.SourceDesc
  • ess.nmx.types
    • ess.nmx.types.TofSimulationMinWavelength
    • ess.nmx.types.TofSimulationMaxWavelength
    • ess.nmx.types.Compression
    • ess.nmx.types.NMXDetectorMetadata
    • ess.nmx.types.NMXMonitorMetadata
    • ess.nmx.types.NMXSampleMetadata
    • ess.nmx.types.NMXSourceMetadata
  • ess.nmx.mtz_io
    • ess.nmx.mtz_io.MTZFileIndex
    • ess.nmx.mtz_io.MTZFilePath
    • ess.nmx.mtz_io.SpaceGroupDesc
    • ess.nmx.mtz_io.DEFAULT_SPACE_GROUP_DESC
    • ess.nmx.mtz_io.WavelengthColumnName
    • ess.nmx.mtz_io.IntensityColumnName
    • ess.nmx.mtz_io.StdDevColumnName
    • ess.nmx.mtz_io.MtzDataFrame
    • ess.nmx.mtz_io.NMXMtzDataFrame
    • ess.nmx.mtz_io.providers
    • ess.nmx.mtz_io.default_parameters
    • ess.nmx.mtz_io.get_reciprocal_asu
    • ess.nmx.mtz_io.get_space_group_from_description
    • ess.nmx.mtz_io.get_space_group_from_mtz
    • ess.nmx.mtz_io.get_unique_space_group
    • ess.nmx.mtz_io.merge_mtz_dataframes
    • ess.nmx.mtz_io.mtz_to_pandas
    • ess.nmx.mtz_io.nmx_mtz_dataframe_to_scipp_dataarray
    • ess.nmx.mtz_io.process_mtz_dataframe
    • ess.nmx.mtz_io.process_single_mtz_to_dataframe
    • ess.nmx.mtz_io.read_mtz_file
  • ess.nmx.scaling
    • ess.nmx.scaling.WavelengthBins
    • ess.nmx.scaling.ReferenceWavelength
    • ess.nmx.scaling.WavelengthBinned
    • ess.nmx.scaling.SelectedReferenceWavelength
    • ess.nmx.scaling.ReferenceIntensities
    • ess.nmx.scaling.EstimatedScaleFactor
    • ess.nmx.scaling.EstimatedScaledIntensities
    • ess.nmx.scaling.ScaledIntensityLeftTailThreshold
    • ess.nmx.scaling.ScaledIntensityRightTailThreshold
    • ess.nmx.scaling.WavelengthScaleFactors
    • ess.nmx.scaling.providers
    • ess.nmx.scaling.default_parameters
    • ess.nmx.scaling.average_roughly_scaled_intensities
    • ess.nmx.scaling.calculate_wavelength_scale_factor
    • ess.nmx.scaling.cut_tails
    • ess.nmx.scaling.estimate_scale_factor_per_hkl_asu_from_reference
    • ess.nmx.scaling.fit_wavelength_scale_factor_polynomial
    • ess.nmx.scaling.get_reference_intensities
    • ess.nmx.scaling.get_reference_wavelength
    • ess.nmx.scaling.get_wavelength_binned
    • ess.nmx.scaling.polyval_wavelength
    • ess.nmx.scaling.FittingResult
  • ess.nmx.configurations
    • ess.nmx.configurations.to_command_arguments
    • ess.nmx.configurations.InputConfig
    • ess.nmx.configurations.OutputConfig
    • ess.nmx.configurations.ReductionConfig
    • ess.nmx.configurations.TimeBinCoordinate
    • ess.nmx.configurations.TimeBinUnit
    • ess.nmx.configurations.WorkflowConfig
On this page
  • load_mcstas()

This Page

  • Show Source
  • API Reference
  • ess.nmx.mcstas
  • ess.nmx.mcstas.load
  • ess.nmx.mcstas.load.load_mcstas

ess.nmx.mcstas.load.load_mcstas#

ess.nmx.mcstas.load.load_mcstas(*, da, experiment_metadata, detector_metadata)[source]#
Return type:

mcstas.types.NMXRawEventCountsDataGroup (scipp.DataGroup)

previous

ess.nmx.mcstas.load.load_experiment_metadata

next

ess.nmx.mcstas.load.load_raw_event_data

© Copyright 2025 Scipp contributors.

Created using Sphinx 9.0.4.

Current ESSnmx version: 26.1.0 (older versions).

Built with the PyData Sphinx Theme 0.16.1.