parameters: (self)
docstring: Property declarations
docstring_summary: Property declarations
docstring_tokens: Property declarations
function: def PyInit(self):
          """ Property declarations """
          self.declareProperty(FileProperty("Filename", "", FileAction.OptionalLoad, ['.nxs']),
                               "Data file to reduce")
          self.declareProperty(WorkspaceProperty("InputWorkspace", "",
                                                 Direction.Input, PropertyMode.Optional),
                               "Optionally, we can provide a workspace directly")
          self.declareProperty(FileProperty("TemplateFile", "", FileAction.OptionalLoad, ['.xml']),
                               "Template reduction file")
  
          # ------------ Properties that should be in the meta data -------------
          self.declareProperty("ScaleToUnity", True,
                               "If true, the reflectivity under the Q cutoff will be scaled to 1")
          self.declareProperty(IntArrayProperty("PrimaryFractionRange", [117, 197],
                                                IntArrayLengthValidator(2), direction=Direction.Input),
                               "Pixel range to use for calculating the primary fraction correction.")
          self.declareProperty(IntArrayProperty("DirectBeamList", [], direction=Direction.Input),
                               "List of direct beam run numbers (integers)")
          self.declareProperty(FileProperty("ScalingFactorFile", "", FileAction.OptionalLoad,
                                            extensions=['.cfg', '.txt']), "Scaling factor file")
          self.declareProperty("IncidentMedium", "medium", "Name of the incident medium")
          # ---------------------------------------------------------------------
  
          self.declareProperty("ScalingFactorTOFStep", 200.0,
                               "Bin width in TOF for fitting scaling factors")
          self.declareProperty("WavelengthOffset", 0.0,
                               "Wavelength offset used for TOF range determination")
          self.declareProperty("ScalingWavelengthCutoff", 10.0,
                               "Wavelength above which the scaling factors are assumed to be one")
          self.declareProperty("FindPeaks", False,
                               "Find reflectivity peaks instead of using the template values")
          self.declareProperty("ReadSequenceFromFile", False,
                               "Read the run sequence information from the file, not the title")
          self.declareProperty("ForceSequenceNumber", 0,
                               "Force the sequence number value if it's not available")
          self.declareProperty("OrderDirectBeamsByRunNumber", False,
                               "Force the sequence of direct beam files to be ordered by run number")
          self.declareProperty("ComputeResolution", True,
                               "If True, the Q resolution will be computed")
          self.declareProperty(FileProperty('OutputFilename', '', action=FileAction.OptionalSave, extensions=["txt"]),
                               doc='Name of the reflectivity file output')
          self.declareProperty(FileProperty("OutputDirectory", "", FileAction.Directory))
  
          self.declareProperty(IntArrayProperty("SequenceInfo", [0, 0, 0], direction=Direction.Output),
                               "Run sequence information (run number, sequence ID, sequence number).")
          self.declareProperty("SlitTolerance", 0.02, doc="Tolerance for matching slit positions")
          self.declareProperty("NormalizationType", "DirectBeam",
                               doc="Normalization type for reduction. Allowed values: ['DirectBeam', 'WithReference']")
          self.declareProperty("Refl1DModelParameters", "",
                               doc="JSON string for Refl1D theoretical model parameters for 'NormalizationType'=='WithReference' ")
function_tokens: def PyInit ( self ) : self . declareProperty ( FileProperty ( "Filename" , "" , FileAction . OptionalLoad , [ '.nxs' ] ) , "Data file to reduce" ) self . declareProperty ( WorkspaceProperty ( "InputWorkspace" , "" , Direction . Input , PropertyMode . Optional ) , "Optionally, we can provide a workspace directly" ) self . declareProperty ( FileProperty ( "TemplateFile" , "" , FileAction . OptionalLoad , [ '.xml' ] ) , "Template reduction file" ) # ------------ Properties that should be in the meta data ------------- self . declareProperty ( "ScaleToUnity" , True , "If true, the reflectivity under the Q cutoff will be scaled to 1" ) self . declareProperty ( IntArrayProperty ( "PrimaryFractionRange" , [ 117 , 197 ] , IntArrayLengthValidator ( 2 ) , direction = Direction . Input ) , "Pixel range to use for calculating the primary fraction correction." ) self . declareProperty ( IntArrayProperty ( "DirectBeamList" , [ ] , direction = Direction . Input ) , "List of direct beam run numbers (integers)" ) self . declareProperty ( FileProperty ( "ScalingFactorFile" , "" , FileAction . OptionalLoad , extensions = [ '.cfg' , '.txt' ] ) , "Scaling factor file" ) self . declareProperty ( "IncidentMedium" , "medium" , "Name of the incident medium" ) # --------------------------------------------------------------------- self . declareProperty ( "ScalingFactorTOFStep" , 200.0 , "Bin width in TOF for fitting scaling factors" ) self . declareProperty ( "WavelengthOffset" , 0.0 , "Wavelength offset used for TOF range determination" ) self . declareProperty ( "ScalingWavelengthCutoff" , 10.0 , "Wavelength above which the scaling factors are assumed to be one" ) self . declareProperty ( "FindPeaks" , False , "Find reflectivity peaks instead of using the template values" ) self . declareProperty ( "ReadSequenceFromFile" , False , "Read the run sequence information from the file, not the title" ) self . declareProperty ( "ForceSequenceNumber" , 0 , "Force the sequence number value if it's not available" ) self . declareProperty ( "OrderDirectBeamsByRunNumber" , False , "Force the sequence of direct beam files to be ordered by run number" ) self . declareProperty ( "ComputeResolution" , True , "If True, the Q resolution will be computed" ) self . declareProperty ( FileProperty ( 'OutputFilename' , '' , action = FileAction . OptionalSave , extensions = [ "txt" ] ) , doc = 'Name of the reflectivity file output' ) self . declareProperty ( FileProperty ( "OutputDirectory" , "" , FileAction . Directory ) ) self . declareProperty ( IntArrayProperty ( "SequenceInfo" , [ 0 , 0 , 0 ] , direction = Direction . Output ) , "Run sequence information (run number, sequence ID, sequence number)." ) self . declareProperty ( "SlitTolerance" , 0.02 , doc = "Tolerance for matching slit positions" ) self . declareProperty ( "NormalizationType" , "DirectBeam" , doc = "Normalization type for reduction. Allowed values: ['DirectBeam', 'WithReference']" ) self . declareProperty ( "Refl1DModelParameters" , "" , doc = "JSON string for Refl1D theoretical model parameters for 'NormalizationType'=='WithReference' " )