parameters: (self)
return_statement: return
docstring: Declare properties
docstring_summary: Declare properties
docstring_tokens: Declare properties
function: def PyInit(self):
          """ Declare properties
          """
          self.declareProperty(MatrixWorkspaceProperty("InputWorkspace", "", Direction.Input, PropertyMode.Optional),
                               "Name of data workspace containing the diffraction pattern in .prf file. ")
  
          self.declareProperty("WorkspaceIndex", 0,
                               "Spectrum (workspace index starting from 0) of the data to refine against in input workspace.")
  
          self.declareProperty(ITableWorkspaceProperty("SeqControlInfoWorkspace", "", Direction.InOut, PropertyMode.Optional),
                               "Name of table workspace containing sequential refinement information.")
  
          self.declareProperty(ITableWorkspaceProperty("InputProfileWorkspace", "", Direction.Input, PropertyMode.Optional),
                               "Name of table workspace containing starting profile parameters.")
  
          self.declareProperty(ITableWorkspaceProperty("InputBraggPeaksWorkspace", "", Direction.Input, PropertyMode.Optional),
                               "Name of table workspace containing a list of reflections. ")
  
          self.declareProperty(ITableWorkspaceProperty("InputBackgroundParameterWorkspace", "", Direction.Input,
                                                       PropertyMode.Optional), "Name of table workspace containing a list of reflections. ")
  
          self.declareProperty("StartX", -0., "Start X (TOF) to refine diffraction pattern.")
          self.declareProperty("EndX",   -0., "End X (TOF) to refine diffraction pattern.")
  
          funcoptions = ["Setup", "Refine", "Save", "Load"]
          self.declareProperty("FunctionOption", "Refine", StringListValidator(funcoptions), "Options of functionality")
  
          #refoptions = ["Levenberg-Marquardt", "Random Walk", "Single Peak Fit"]
          refoptions = ["Random Walk"]
          self.declareProperty("RefinementOption", "Random Walk", StringListValidator(refoptions),
                               "Options of algorithm to refine. ")
  
          self.declareProperty(StringArrayProperty("ParametersToRefine", values=[], direction=Direction.Input),
                               "List of parameters to refine.")
  
          self.declareProperty("NumRefineCycles", 1, "Number of refinement cycles.")
  
          peaktypes = ["", "Neutron Back-to-back exponential convoluted with pseudo-voigt",
                       "Thermal neutron Back-to-back exponential convoluted with pseudo-voigt"]
          self.declareProperty("ProfileType", "", StringListValidator(peaktypes), "Type of peak profile function.")
  
          bkgdtypes = ["", "Polynomial", "Chebyshev", "FullprofPolynomial"]
          self.declareProperty("BackgroundType", "", StringListValidator(bkgdtypes), "Type of background function.")
  
          self.declareProperty("FromStep", -1, "If non-negative, the previous code is not set from last step, but the step specified.")
  
          # Property for save project
          self.declareProperty(FileProperty("OutputProjectFilename","", FileAction.OptionalSave, ['.nxs']),
                               "Name of sequential project file.")
  
          # Property for save project
          self.declareProperty(FileProperty("InputProjectFilename","", FileAction.OptionalLoad, ['.nxs']),
                               "Name of sequential project file.")
  
          # Project ID
          self.declareProperty("ProjectID", "", "Project ID.")
  
          return
function_tokens: def PyInit ( self ) : self . declareProperty ( MatrixWorkspaceProperty ( "InputWorkspace" , "" , Direction . Input , PropertyMode . Optional ) , "Name of data workspace containing the diffraction pattern in .prf file. " ) self . declareProperty ( "WorkspaceIndex" , 0 , "Spectrum (workspace index starting from 0) of the data to refine against in input workspace." ) self . declareProperty ( ITableWorkspaceProperty ( "SeqControlInfoWorkspace" , "" , Direction . InOut , PropertyMode . Optional ) , "Name of table workspace containing sequential refinement information." ) self . declareProperty ( ITableWorkspaceProperty ( "InputProfileWorkspace" , "" , Direction . Input , PropertyMode . Optional ) , "Name of table workspace containing starting profile parameters." ) self . declareProperty ( ITableWorkspaceProperty ( "InputBraggPeaksWorkspace" , "" , Direction . Input , PropertyMode . Optional ) , "Name of table workspace containing a list of reflections. " ) self . declareProperty ( ITableWorkspaceProperty ( "InputBackgroundParameterWorkspace" , "" , Direction . Input , PropertyMode . Optional ) , "Name of table workspace containing a list of reflections. " ) self . declareProperty ( "StartX" , - 0. , "Start X (TOF) to refine diffraction pattern." ) self . declareProperty ( "EndX" , - 0. , "End X (TOF) to refine diffraction pattern." ) funcoptions = [ "Setup" , "Refine" , "Save" , "Load" ] self . declareProperty ( "FunctionOption" , "Refine" , StringListValidator ( funcoptions ) , "Options of functionality" ) #refoptions = ["Levenberg-Marquardt", "Random Walk", "Single Peak Fit"] refoptions = [ "Random Walk" ] self . declareProperty ( "RefinementOption" , "Random Walk" , StringListValidator ( refoptions ) , "Options of algorithm to refine. " ) self . declareProperty ( StringArrayProperty ( "ParametersToRefine" , values = [ ] , direction = Direction . Input ) , "List of parameters to refine." ) self . declareProperty ( "NumRefineCycles" , 1 , "Number of refinement cycles." ) peaktypes = [ "" , "Neutron Back-to-back exponential convoluted with pseudo-voigt" , "Thermal neutron Back-to-back exponential convoluted with pseudo-voigt" ] self . declareProperty ( "ProfileType" , "" , StringListValidator ( peaktypes ) , "Type of peak profile function." ) bkgdtypes = [ "" , "Polynomial" , "Chebyshev" , "FullprofPolynomial" ] self . declareProperty ( "BackgroundType" , "" , StringListValidator ( bkgdtypes ) , "Type of background function." ) self . declareProperty ( "FromStep" , - 1 , "If non-negative, the previous code is not set from last step, but the step specified." ) # Property for save project self . declareProperty ( FileProperty ( "OutputProjectFilename" , "" , FileAction . OptionalSave , [ '.nxs' ] ) , "Name of sequential project file." ) # Property for save project self . declareProperty ( FileProperty ( "InputProjectFilename" , "" , FileAction . OptionalLoad , [ '.nxs' ] ) , "Name of sequential project file." ) # Project ID self . declareProperty ( "ProjectID" , "" , "Project ID." ) return