Developer Documentation

• SasData
  • Subpackages
    • sasdata.data_util package
      • Submodules
        • sasdata.data_util.err1d module
          • add()
          • add_inplace()
          • div()
          • div_inplace()
          • exp()
          • log()
          • mul()
          • mul_inplace()
          • pow()
          • pow_inplace()
          • sub()
          • sub_inplace()
        • sasdata.data_util.formatnum module
          • UncertaintyFormatter
            • UncertaintyFormatter.__call__()
            • UncertaintyFormatter.__dict__
            • UncertaintyFormatter.__doc__
            • UncertaintyFormatter.__module__
            • UncertaintyFormatter.__weakref__
            • UncertaintyFormatter.compact
          • _format_uncertainty()
          • format_uncertainty_compact()
          • format_uncertainty_pm()
          • main()
          • test_compact()
          • test_default()
          • test_pm()
        • sasdata.data_util.loader_exceptions module
          • DataReaderException
            • DataReaderException.__doc__
            • DataReaderException.__init__()
            • DataReaderException.__module__
            • DataReaderException.__weakref__
          • DefaultReaderException
            • DefaultReaderException.__doc__
            • DefaultReaderException.__init__()
            • DefaultReaderException.__module__
            • DefaultReaderException.__weakref__
          • FileContentsException
            • FileContentsException.__doc__
            • FileContentsException.__init__()
            • FileContentsException.__module__
            • FileContentsException.__weakref__
          • NoKnownLoaderException
            • NoKnownLoaderException.__doc__
            • NoKnownLoaderException.__init__()
            • NoKnownLoaderException.__module__
            • NoKnownLoaderException.__weakref__
        • sasdata.data_util.manipulations module
          • Binning
            • Binning.__dict__
            • Binning.__doc__
            • Binning.__init__()
            • Binning.__module__
            • Binning.__weakref__
            • Binning.get_bin_index()
          • Boxavg
            • Boxavg.__call__()
            • Boxavg.__doc__
            • Boxavg.__init__()
            • Boxavg.__module__
          • Boxcut
            • Boxcut.__call__()
            • Boxcut.__dict__
            • Boxcut.__doc__
            • Boxcut.__init__()
            • Boxcut.__module__
            • Boxcut.__weakref__
            • Boxcut._find()
          • Boxsum
            • Boxsum.__annotations__
            • Boxsum.__call__()
            • Boxsum.__dict__
            • Boxsum.__doc__
            • Boxsum.__init__()
            • Boxsum.__module__
            • Boxsum.__weakref__
            • Boxsum._sum()
          • CircularAverage
            • CircularAverage.__call__()
            • CircularAverage.__dict__
            • CircularAverage.__doc__
            • CircularAverage.__init__()
            • CircularAverage.__module__
            • CircularAverage.__weakref__
          • Ring
            • Ring.__call__()
            • Ring.__dict__
            • Ring.__doc__
            • Ring.__init__()
            • Ring.__module__
            • Ring.__weakref__
          • Ringcut
            • Ringcut.__call__()
            • Ringcut.__dict__
            • Ringcut.__doc__
            • Ringcut.__init__()
            • Ringcut.__module__
            • Ringcut.__weakref__
          • SectorPhi
            • SectorPhi.__call__()
            • SectorPhi.__doc__
            • SectorPhi.__module__
          • SectorQ
            • SectorQ.__annotations__
            • SectorQ.__call__()
            • SectorQ.__doc__
            • SectorQ.__module__
          • Sectorcut
            • Sectorcut.__call__()
            • Sectorcut.__dict__
            • Sectorcut.__doc__
            • Sectorcut.__init__()
            • Sectorcut.__module__
            • Sectorcut.__weakref__
            • Sectorcut._find()
          • SlabX
            • SlabX.__call__()
            • SlabX.__doc__
            • SlabX.__module__
          • SlabY
            • SlabY.__annotations__
            • SlabY.__call__()
            • SlabY.__doc__
            • SlabY.__module__
          • _Sector
            • _Sector.__annotations__
            • _Sector.__dict__
            • _Sector.__doc__
            • _Sector.__init__()
            • _Sector.__module__
            • _Sector.__weakref__
            • _Sector._agv()
          • _Slab
            • _Slab.__annotations__
            • _Slab.__call__()
            • _Slab.__dict__
            • _Slab.__doc__
            • _Slab.__init__()
            • _Slab.__module__
            • _Slab.__weakref__
            • _Slab._avg()
          • flip_phi()
          • get_dq_data()
          • get_intercept()
          • get_pixel_fraction()
          • get_pixel_fraction_square()
          • get_q_compo()
          • position_and_wavelength_to_q()
          • reader2D_converter()
        • sasdata.data_util.nxsunit module
          • Converter
            • Converter.__call__()
            • Converter.__dict__
            • Converter.__doc__
            • Converter.__init__()
            • Converter.__module__
            • Converter.__weakref__
            • Converter._get_scale_for_units()
            • Converter._scale_with_offset()
            • Converter._units
            • Converter.dimension
            • Converter.get_compatible_units()
            • Converter.scale()
            • Converter.scalebase
            • Converter.scalemap
            • Converter.scaleoffset
            • Converter.units
          • TypeVar
            • TypeVar.__dict__
            • TypeVar.__doc__
            • TypeVar.__init__()
            • TypeVar.__module__
            • TypeVar.__typing_subst__()
            • TypeVar.__weakref__
          • _build_all_units()
          • _build_degree_units()
          • _build_inv_n_metric_units()
          • _build_inv_n_units()
          • _build_metric_units()
          • _build_plural_units()
          • _format_unit_structure()
          • standardize_units()
        • sasdata.data_util.registry module
          • CustomFileOpen
            • CustomFileOpen.__dict__
            • CustomFileOpen.__doc__
            • CustomFileOpen.__enter__()
            • CustomFileOpen.__exit__()
            • CustomFileOpen.__init__()
            • CustomFileOpen.__module__
            • CustomFileOpen.__weakref__
          • ExtensionRegistry
            • ExtensionRegistry.__contains__()
            • ExtensionRegistry.__dict__
            • ExtensionRegistry.__doc__
            • ExtensionRegistry.__getitem__()
            • ExtensionRegistry.__init__()
            • ExtensionRegistry.__module__
            • ExtensionRegistry.__setitem__()
            • ExtensionRegistry.__weakref__
            • ExtensionRegistry.extensions()
            • ExtensionRegistry.formats()
            • ExtensionRegistry.load()
            • ExtensionRegistry.lookup()
          • create_empty_data_with_errors()
        • sasdata.data_util.uncertainty module
          • Uncertainty
            • Uncertainty.__abs__()
            • Uncertainty.__add__()
            • Uncertainty.__and__()
            • Uncertainty.__coerce__()
            • Uncertainty.__complex__()
            • Uncertainty.__delitem__()
            • Uncertainty.__dict__
            • Uncertainty.__div__()
            • Uncertainty.__divmod__()
            • Uncertainty.__doc__
            • Uncertainty.__float__()
            • Uncertainty.__floordiv__()
            • Uncertainty.__getitem__()
            • Uncertainty.__hex__()
            • Uncertainty.__iadd__()
            • Uncertainty.__iand__()
            • Uncertainty.__idiv__()
            • Uncertainty.__idivmod__()
            • Uncertainty.__ifloordiv__()
            • Uncertainty.__ilshift__()
            • Uncertainty.__imod__()
            • Uncertainty.__imul__()
            • Uncertainty.__index__()
            • Uncertainty.__init__()
            • Uncertainty.__int__()
            • Uncertainty.__invert__()
            • Uncertainty.__ior__()
            • Uncertainty.__ipow__()
            • Uncertainty.__irshift__()
            • Uncertainty.__isub__()
            • Uncertainty.__itruediv__()
            • Uncertainty.__ixor__()
            • Uncertainty.__len__()
            • Uncertainty.__long__()
            • Uncertainty.__lshift__()
            • Uncertainty.__mod__()
            • Uncertainty.__module__
            • Uncertainty.__mul__()
            • Uncertainty.__neg__()
            • Uncertainty.__oct__()
            • Uncertainty.__or__()
            • Uncertainty.__pos__()
            • Uncertainty.__pow__()
            • Uncertainty.__radd__()
            • Uncertainty.__rand__()
            • Uncertainty.__rdiv__()
            • Uncertainty.__rdivmod__()
            • Uncertainty.__repr__()
            • Uncertainty.__rfloordiv__()
            • Uncertainty.__rlshift__()
            • Uncertainty.__rmod__()
            • Uncertainty.__rmul__()
            • Uncertainty.__ror__()
            • Uncertainty.__rpow__()
            • Uncertainty.__rrshift__()
            • Uncertainty.__rshift__()
            • Uncertainty.__rsub__()
            • Uncertainty.__rtruediv__()
            • Uncertainty.__rxor__()
            • Uncertainty.__setitem__()
            • Uncertainty.__str__()
            • Uncertainty.__sub__()
            • Uncertainty.__truediv__()
            • Uncertainty.__weakref__
            • Uncertainty.__xor__()
            • Uncertainty._getdx()
            • Uncertainty._setdx()
            • Uncertainty.dx
            • Uncertainty.exp()
            • Uncertainty.log()
          • exp()
          • log()
          • test()
        • sasdata.data_util.util module
          • unique_preserve_order()
      • Module contents
    • sasdata.dataloader package
      • Subpackages
        • sasdata.dataloader.readers package
          • Submodules
            • sasdata.dataloader.readers.abs_reader module
              • Reader
            • sasdata.dataloader.readers.anton_paar_saxs_reader module
              • Reader
            • sasdata.dataloader.readers.ascii_reader module
              • Reader
            • sasdata.dataloader.readers.associations module
              • get_fallback_readers()
              • read_associations()
            • sasdata.dataloader.readers.cansas_constants module
              • CansasConstants
              • CurrentLevel
            • sasdata.dataloader.readers.cansas_reader module
              • Reader
              • get_content()
              • getattrchain()
              • setattrchain()
              • write_node()
            • sasdata.dataloader.readers.cansas_reader_HDF5 module
              • Reader
              • h5attr()
            • sasdata.dataloader.readers.csv_reader module
              • Reader
            • sasdata.dataloader.readers.danse_reader module
              • Reader
            • sasdata.dataloader.readers.red2d_reader module
              • Reader
              • check_point()
            • sasdata.dataloader.readers.sesans_reader module
              • Reader
            • sasdata.dataloader.readers.tiff_reader module
              • Reader
            • sasdata.dataloader.readers.xml_reader module
              • XMLreader
              • uri_is_valid()
          • Module contents
      • Submodules
        • sasdata.dataloader.data_info module
          • Aperture
            • Aperture.__dict__
            • Aperture.__doc__
            • Aperture.__init__()
            • Aperture.__module__
            • Aperture.__weakref__
            • Aperture.distance
            • Aperture.distance_unit
            • Aperture.name
            • Aperture.size
            • Aperture.size_name
            • Aperture.size_unit
            • Aperture.type
          • Collimation
            • Collimation.__dict__
            • Collimation.__doc__
            • Collimation.__init__()
            • Collimation.__module__
            • Collimation.__str__()
            • Collimation.__weakref__
            • Collimation.aperture
            • Collimation.length
            • Collimation.length_unit
            • Collimation.name
          • Data1D
            • Data1D.__doc__
            • Data1D.__init__()
            • Data1D.__module__
            • Data1D.__str__()
            • Data1D._perform_operation()
            • Data1D._perform_union()
            • Data1D._validity_check()
            • Data1D._validity_check_union()
            • Data1D.clone_without_data()
            • Data1D.copy_from_datainfo()
            • Data1D.is_slit_smeared()
          • Data2D
            • Data2D.I_unit
            • Data2D.Q_unit
            • Data2D.__annotations__
            • Data2D.__doc__
            • Data2D.__init__()
            • Data2D.__module__
            • Data2D.__str__()
            • Data2D._perform_operation()
            • Data2D._perform_union()
            • Data2D._validity_check()
            • Data2D._validity_check_union()
            • Data2D.clone_without_data()
            • Data2D.copy_from_datainfo()
            • Data2D.isSesans
          • DataInfo
            • DataInfo.__add__()
            • DataInfo.__annotations__
            • DataInfo.__dict__
            • DataInfo.__div__()
            • DataInfo.__doc__
            • DataInfo.__init__()
            • DataInfo.__module__
            • DataInfo.__mul__()
            • DataInfo.__or__()
            • DataInfo.__radd__()
            • DataInfo.__rdiv__()
            • DataInfo.__rmul__()
            • DataInfo.__ror__()
            • DataInfo.__rsub__()
            • DataInfo.__rtruediv__()
            • DataInfo.__str__()
            • DataInfo.__sub__()
            • DataInfo.__truediv__()
            • DataInfo.__weakref__
            • DataInfo._perform_operation()
            • DataInfo._perform_union()
            • DataInfo.add_notes()
            • DataInfo.append_empty_process()
            • DataInfo.collimation
            • DataInfo.detector
            • DataInfo.errors
            • DataInfo.filename
            • DataInfo.instrument
            • DataInfo.isSesans
            • DataInfo.meta_data
            • DataInfo.notes
            • DataInfo.process
            • DataInfo.run
            • DataInfo.run_name
            • DataInfo.sample
            • DataInfo.source
            • DataInfo.title
            • DataInfo.trans_spectrum
          • Detector
            • Detector.__dict__
            • Detector.__doc__
            • Detector.__init__()
            • Detector.__module__
            • Detector.__str__()
            • Detector.__weakref__
            • Detector.beam_center
            • Detector.beam_center_unit
            • Detector.distance
            • Detector.distance_unit
            • Detector.name
            • Detector.offset
            • Detector.offset_unit
            • Detector.orientation
            • Detector.orientation_unit
            • Detector.pixel_size
            • Detector.pixel_size_unit
            • Detector.slit_length
            • Detector.slit_length_unit
          • Process
            • Process.__dict__
            • Process.__doc__
            • Process.__init__()
            • Process.__module__
            • Process.__str__()
            • Process.__weakref__
            • Process.date
            • Process.description
            • Process.is_empty()
            • Process.name
            • Process.notes
            • Process.single_line_desc()
            • Process.term
          • Sample
            • Sample.ID
            • Sample.__dict__
            • Sample.__doc__
            • Sample.__init__()
            • Sample.__module__
            • Sample.__str__()
            • Sample.__weakref__
            • Sample.details
            • Sample.name
            • Sample.orientation
            • Sample.orientation_unit
            • Sample.position
            • Sample.position_unit
            • Sample.temperature
            • Sample.temperature_unit
            • Sample.thickness
            • Sample.thickness_unit
            • Sample.transmission
            • Sample.yacceptance
            • Sample.zacceptance
          • Source
            • Source.__dict__
            • Source.__doc__
            • Source.__init__()
            • Source.__module__
            • Source.__str__()
            • Source.__weakref__
            • Source.beam_shape
            • Source.beam_size
            • Source.beam_size_name
            • Source.beam_size_unit
            • Source.name
            • Source.probe
            • Source.radiation
            • Source.type
            • Source.wavelength
            • Source.wavelength_max
            • Source.wavelength_max_unit
            • Source.wavelength_min
            • Source.wavelength_min_unit
            • Source.wavelength_spread
            • Source.wavelength_spread_unit
            • Source.wavelength_unit
          • TransmissionSpectrum
            • TransmissionSpectrum.__dict__
            • TransmissionSpectrum.__doc__
            • TransmissionSpectrum.__init__()
            • TransmissionSpectrum.__module__
            • TransmissionSpectrum.__str__()
            • TransmissionSpectrum.__weakref__
            • TransmissionSpectrum.name
            • TransmissionSpectrum.timestamp
            • TransmissionSpectrum.transmission
            • TransmissionSpectrum.transmission_deviation
            • TransmissionSpectrum.transmission_deviation_unit
            • TransmissionSpectrum.transmission_unit
            • TransmissionSpectrum.wavelength
            • TransmissionSpectrum.wavelength_unit
          • Vector
            • Vector.__dict__
            • Vector.__doc__
            • Vector.__init__()
            • Vector.__module__
            • Vector.__str__()
            • Vector.__weakref__
            • Vector.x
            • Vector.y
            • Vector.z
          • combine_data_info_with_plottable()
          • plottable_1D
            • plottable_1D.__annotations__
            • plottable_1D.__dict__
            • plottable_1D.__doc__
            • plottable_1D.__init__()
            • plottable_1D.__module__
            • plottable_1D.__weakref__
            • plottable_1D._xaxis
            • plottable_1D._xunit
            • plottable_1D._yaxis
            • plottable_1D._yunit
            • plottable_1D.dlam
            • plottable_1D.dx
            • plottable_1D.dxl
            • plottable_1D.dxw
            • plottable_1D.dy
            • plottable_1D.lam
            • plottable_1D.x
            • plottable_1D.xaxis()
            • plottable_1D.y
            • plottable_1D.yaxis()
          • plottable_2D
            • plottable_2D.__annotations__
            • plottable_2D.__dict__
            • plottable_2D.__doc__
            • plottable_2D.__init__()
            • plottable_2D.__module__
            • plottable_2D.__weakref__
            • plottable_2D._xaxis
            • plottable_2D._xunit
            • plottable_2D._yaxis
            • plottable_2D._yunit
            • plottable_2D._zaxis
            • plottable_2D._zunit
            • plottable_2D.data
            • plottable_2D.dqx_data
            • plottable_2D.dqy_data
            • plottable_2D.err_data
            • plottable_2D.mask
            • plottable_2D.q_data
            • plottable_2D.qx_data
            • plottable_2D.qy_data
            • plottable_2D.x_bins
            • plottable_2D.xaxis()
            • plottable_2D.xmax
            • plottable_2D.xmin
            • plottable_2D.y_bins
            • plottable_2D.yaxis()
            • plottable_2D.ymax
            • plottable_2D.ymin
            • plottable_2D.zaxis()
        • sasdata.dataloader.filereader module
          • FileReader
            • FileReader.__dict__
            • FileReader.__doc__
            • FileReader.__init__()
            • FileReader.__module__
            • FileReader.__weakref__
            • FileReader._read()
            • FileReader._remove_nans_in_data()
            • FileReader._reorder_1d_array()
            • FileReader.allow_all
            • FileReader.convert_data_units()
            • FileReader.data_cleanup()
            • FileReader.ext
            • FileReader.format_unit()
            • FileReader.get_file_contents()
            • FileReader.handle_error_message()
            • FileReader.has_converter
            • FileReader.nextline()
            • FileReader.nextlines()
            • FileReader.read()
            • FileReader.readall()
            • FileReader.remove_empty_q_values()
            • FileReader.reset_data_list()
            • FileReader.reset_state()
            • FileReader.send_to_output()
            • FileReader.set_all_to_none()
            • FileReader.set_default_1d_units()
            • FileReader.set_default_2d_units()
            • FileReader.sort_data()
            • FileReader.splitline()
            • FileReader.type
            • FileReader.type_name
          • decode()
        • sasdata.dataloader.loader module
          • Loader
            • Loader.__call__()
            • Loader.__dict__
            • Loader.__doc__
            • Loader.__module__
            • Loader.__registry
            • Loader.__weakref__
            • Loader._get_registry_creation_time()
            • Loader.associate_file_reader()
            • Loader.associate_file_type()
            • Loader.find_plugins()
            • Loader.get_wildcards()
            • Loader.load()
            • Loader.save()
          • Registry
            • Registry.__annotations__
            • Registry.__doc__
            • Registry.__init__()
            • Registry.__module__
            • Registry._identify_plugin()
            • Registry.associate_file_reader()
            • Registry.associate_file_type()
            • Registry.find_plugins()
            • Registry.load()
            • Registry.lookup_writers()
            • Registry.save()
      • Module contents
    • sasdata.example_data package
      • Module contents
    • sasdata.file_converter package
      • Submodules
        • sasdata.file_converter.FileConverterUtilities module
          • convert_2d_data()
          • convert_to_cansas()
          • extract_ascii_data()
          • extract_otoko_data()
          • toFloat()
        • sasdata.file_converter.ascii2d_loader module
          • ASCII2DLoader
            • ASCII2DLoader.__dict__
            • ASCII2DLoader.__doc__
            • ASCII2DLoader.__init__()
            • ASCII2DLoader.__module__
            • ASCII2DLoader.__weakref__
            • ASCII2DLoader.load()
        • sasdata.file_converter.bsl_loader module
          • BSLLoader
            • BSLLoader.__dict__
            • BSLLoader.__doc__
            • BSLLoader.__init__()
            • BSLLoader.__module__
            • BSLLoader.__str__()
            • BSLLoader.__weakref__
            • BSLLoader._parse_header()
            • BSLLoader.filename
            • BSLLoader.load_data()
            • BSLLoader.load_frames()
            • BSLLoader.n_frames
            • BSLLoader.n_pixels
            • BSLLoader.n_rasters
            • BSLLoader.swap_bytes
          • BSLParsingError
            • BSLParsingError.__doc__
            • BSLParsingError.__module__
            • BSLParsingError.__weakref__
        • sasdata.file_converter.cansas_writer module
          • CansasWriter
            • CansasWriter.__annotations__
            • CansasWriter.__doc__
            • CansasWriter.__module__
            • CansasWriter._to_xml_doc()
            • CansasWriter._write_data()
            • CansasWriter.write()
        • sasdata.file_converter.nxcansas_writer module
          • NXcanSASWriter
            • NXcanSASWriter.__dict__
            • NXcanSASWriter.__doc__
            • NXcanSASWriter.__module__
            • NXcanSASWriter.__weakref__
            • NXcanSASWriter._write_1d_data()
            • NXcanSASWriter._write_2d_data()
            • NXcanSASWriter.write()
        • sasdata.file_converter.otoko_loader module
          • CStyleStruct
            • CStyleStruct.__dict__
            • CStyleStruct.__doc__
            • CStyleStruct.__init__()
            • CStyleStruct.__module__
            • CStyleStruct.__weakref__
          • OTOKOData
            • OTOKOData.__dict__
            • OTOKOData.__doc__
            • OTOKOData.__init__()
            • OTOKOData.__module__
            • OTOKOData.__weakref__
          • OTOKOLoader
            • OTOKOLoader.__dict__
            • OTOKOLoader.__doc__
            • OTOKOLoader.__init__()
            • OTOKOLoader.__module__
            • OTOKOLoader.__weakref__
            • OTOKOLoader._load_otoko_axis()
            • OTOKOLoader.load_otoko_data()
          • OTOKOParsingError
            • OTOKOParsingError.__doc__
            • OTOKOParsingError.__module__
            • OTOKOParsingError.__weakref__
        • sasdata.file_converter.red2d_writer module
          • Red2DWriter
            • Red2DWriter.__annotations__
            • Red2DWriter.__doc__
            • Red2DWriter.__module__
            • Red2DWriter.write()
      • Module contents
  • Module contents