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

Section Navigation

  • scippneutron.array_from_mantid
  • scippneutron.from_mantid
  • scippneutron.load_with_mantid
  • scippneutron.to_mantid
  • scippneutron.fit
  • scippneutron.convert
  • scippneutron.position
  • scippneutron.source_position
  • scippneutron.sample_position
  • scippneutron.Ltotal
  • scippneutron.L1
  • scippneutron.L2
  • scippneutron.two_theta
  • scippneutron.incident_beam
  • scippneutron.scattered_beam
  • scippneutron.atoms
    • scippneutron.atoms.reference_wavelength
    • scippneutron.atoms.ScatteringParams
  • scippneutron.chopper
    • scippneutron.chopper.disk_chopper
      • scippneutron.chopper.disk_chopper.DiskChopper
      • scippneutron.chopper.disk_chopper.DiskChopperType
    • scippneutron.chopper.filtering
      • scippneutron.chopper.filtering.collapse_plateaus
      • scippneutron.chopper.filtering.filter_in_phase
      • scippneutron.chopper.filtering.find_plateaus
    • scippneutron.chopper.nexus_chopper
      • scippneutron.chopper.nexus_chopper.extract_chopper_from_nexus
  • scippneutron.conversion
    • scippneutron.conversion.beamline
      • scippneutron.conversion.beamline.L1
      • scippneutron.conversion.beamline.L2
      • scippneutron.conversion.beamline.beam_aligned_unit_vectors
      • scippneutron.conversion.beamline.scattering_angle_in_yz_plane
      • scippneutron.conversion.beamline.scattering_angles_with_gravity
      • scippneutron.conversion.beamline.straight_incident_beam
      • scippneutron.conversion.beamline.straight_scattered_beam
      • scippneutron.conversion.beamline.total_beam_length
      • scippneutron.conversion.beamline.total_straight_beam_length_no_scatter
      • scippneutron.conversion.beamline.two_theta
      • scippneutron.conversion.beamline.BeamAlignedUnitVectors
      • scippneutron.conversion.beamline.SphericalCoordinates
    • scippneutron.conversion.graph
      • scippneutron.conversion.graph.beamline
        • scippneutron.conversion.graph.beamline.L1
        • scippneutron.conversion.graph.beamline.L2
        • scippneutron.conversion.graph.beamline.Ltotal
        • scippneutron.conversion.graph.beamline.beamline
        • scippneutron.conversion.graph.beamline.incident_beam
        • scippneutron.conversion.graph.beamline.scattered_beam
        • scippneutron.conversion.graph.beamline.two_theta
      • scippneutron.conversion.graph.tof
        • scippneutron.conversion.graph.tof.direct_inelastic
        • scippneutron.conversion.graph.tof.elastic
        • scippneutron.conversion.graph.tof.elastic_Q
        • scippneutron.conversion.graph.tof.elastic_Q_vec
        • scippneutron.conversion.graph.tof.elastic_dspacing
        • scippneutron.conversion.graph.tof.elastic_energy
        • scippneutron.conversion.graph.tof.elastic_hkl
        • scippneutron.conversion.graph.tof.elastic_wavelength
        • scippneutron.conversion.graph.tof.indirect_inelastic
        • scippneutron.conversion.graph.tof.kinematic
    • scippneutron.conversion.tof
      • scippneutron.conversion.tof.Q_elements_from_wavelength
      • scippneutron.conversion.tof.Q_from_wavelength
      • scippneutron.conversion.tof.Q_vec_from_Q_elements
      • scippneutron.conversion.tof.dspacing_from_energy
      • scippneutron.conversion.tof.dspacing_from_tof
      • scippneutron.conversion.tof.dspacing_from_wavelength
      • scippneutron.conversion.tof.energy_from_tof
      • scippneutron.conversion.tof.energy_from_wavelength
      • scippneutron.conversion.tof.energy_transfer_direct_from_tof
      • scippneutron.conversion.tof.energy_transfer_indirect_from_tof
      • scippneutron.conversion.tof.hkl_elements_from_hkl_vec
      • scippneutron.conversion.tof.hkl_vec_from_Q_vec
      • scippneutron.conversion.tof.time_at_sample_from_tof
      • scippneutron.conversion.tof.ub_matrix_from_u_and_b
      • scippneutron.conversion.tof.wavelength_from_Q
      • scippneutron.conversion.tof.wavelength_from_energy
      • scippneutron.conversion.tof.wavelength_from_tof
  • scippneutron.io
    • scippneutron.io.cif
      • scippneutron.io.cif.save_cif
      • scippneutron.io.cif.Author
      • scippneutron.io.cif.Block
      • scippneutron.io.cif.CIF
      • scippneutron.io.cif.CIFSchema
      • scippneutron.io.cif.Chunk
      • scippneutron.io.cif.Loop
    • scippneutron.io.xye
      • scippneutron.io.xye.load_xye
      • scippneutron.io.xye.save_xye
      • scippneutron.io.xye.GenerateHeaderType
  • scippneutron.logging
    • scippneutron.logging.get_logger
    • scippneutron.logging.logger_name
  • scippneutron.peaks
    • scippneutron.peaks.FitAssessment
    • scippneutron.peaks.FitParameters
    • scippneutron.peaks.FitResult
    • scippneutron.peaks.FitRequirements
    • scippneutron.peaks.fit_peaks
    • scippneutron.peaks.remove_peaks
    • scippneutron.peaks.model
      • scippneutron.peaks.model.CompositeModel
      • scippneutron.peaks.model.GaussianModel
      • scippneutron.peaks.model.LorentzianModel
      • scippneutron.peaks.model.Model
      • scippneutron.peaks.model.PolynomialModel
      • scippneutron.peaks.model.PseudoVoigtModel
  • scippneutron.tof
    • scippneutron.tof.chopper_cascade
      • scippneutron.tof.chopper_cascade.propagate_times
      • scippneutron.tof.chopper_cascade.wavelength_to_inverse_velocity
      • scippneutron.tof.chopper_cascade.Chopper
      • scippneutron.tof.chopper_cascade.Frame
      • scippneutron.tof.chopper_cascade.FrameSequence
      • scippneutron.tof.chopper_cascade.Subframe
    • scippneutron.tof.diagram
      • scippneutron.tof.diagram.TimeDistanceDiagram
    • scippneutron.tof.fakes
      • scippneutron.tof.fakes.FakeBeamline
      • scippneutron.tof.fakes.FakeBeamlineEss
      • scippneutron.tof.fakes.FakePulse
      • scippneutron.tof.fakes.FakeSource
    • scippneutron.tof.unwrap
      • scippneutron.tof.unwrap.ChopperCascadeFrames
      • scippneutron.tof.unwrap.Choppers
      • scippneutron.tof.unwrap.FrameAtSample
      • scippneutron.tof.unwrap.FrameAtDetector
      • scippneutron.tof.unwrap.CleanFrameAtDetector
      • scippneutron.tof.unwrap.FrameBounds
      • scippneutron.tof.unwrap.FrameForTimeOfFlightOrigin
      • scippneutron.tof.unwrap.FramePeriod
      • scippneutron.tof.unwrap.FrameWrappedTimeOffset
      • scippneutron.tof.unwrap.Ltotal
      • scippneutron.tof.unwrap.PulseOffset
      • scippneutron.tof.unwrap.PulsePeriod
      • scippneutron.tof.unwrap.PulseStride
      • scippneutron.tof.unwrap.PulseWrappedTimeOffset
      • scippneutron.tof.unwrap.RawData
      • scippneutron.tof.unwrap.SourceChopperName
      • scippneutron.tof.unwrap.SourceChopper
      • scippneutron.tof.unwrap.SampleDistance
      • scippneutron.tof.unwrap.SourceTimeRange
      • scippneutron.tof.unwrap.SourceWavelengthRange
      • scippneutron.tof.unwrap.TimeZero
      • scippneutron.tof.unwrap.UnwrappedData
      • scippneutron.tof.unwrap.TimeOfFlightOriginDistance
      • scippneutron.tof.unwrap.TimeOfFlightOriginTime
      • scippneutron.tof.unwrap.TofData
      • scippneutron.tof.unwrap.TimeOffset
      • scippneutron.tof.unwrap.DeltaFromWrapped
      • scippneutron.tof.unwrap.chopper_cascade_frames
      • scippneutron.tof.unwrap.frame_at_detector
      • scippneutron.tof.unwrap.frame_bounds
      • scippneutron.tof.unwrap.frame_period
      • scippneutron.tof.unwrap.frame_wrapped_time_offset
      • scippneutron.tof.unwrap.frame_wrapped_time_offset_pulse_skipping
      • scippneutron.tof.unwrap.maybe_clip_detector_subframes
      • scippneutron.tof.unwrap.offset_from_wrapped
      • scippneutron.tof.unwrap.pulse_offset
      • scippneutron.tof.unwrap.pulse_wrapped_time_offset
      • scippneutron.tof.unwrap.source_chopper
      • scippneutron.tof.unwrap.time_of_flight_origin_from_chopper
      • scippneutron.tof.unwrap.time_of_flight_origin_from_choppers_providers
      • scippneutron.tof.unwrap.time_of_flight_origin_wfm
      • scippneutron.tof.unwrap.time_of_flight_providers
      • scippneutron.tof.unwrap.time_offset
      • scippneutron.tof.unwrap.time_zero
      • scippneutron.tof.unwrap.to_time_of_flight
      • scippneutron.tof.unwrap.unwrap_data
      • scippneutron.tof.unwrap.unwrap_providers
      • scippneutron.tof.unwrap.TimeOfFlightOrigin
On this page
  • frame_period()
Show Source
  • API Reference
  • scippneutron.tof
  • scippneutron.tof.unwrap
  • scippneutron.tof.unwrap.frame_period

scippneutron.tof.unwrap.frame_period#

scippneutron.tof.unwrap.frame_period(pulse_period, pulse_stride)[source]#
Return type:

tof.unwrap.FramePeriod (scipp.Variable)

previous

scippneutron.tof.unwrap.frame_bounds

next

scippneutron.tof.unwrap.frame_wrapped_time_offset

© Copyright 2024 Scipp contributors.

Created using Sphinx 8.1.3.

Current ScippNeutron version: 24.11.0 (older versions).

Built with the PyData Sphinx Theme 0.16.0.