Modules.CutFile.CutFile Class Reference

Public Member Functions
def	__init__
def	set_info
def	load_file
def	save
def	split
def	copy_info

Public Attributes
	directory
	element
	count
	is_elem_loss
	split_number
	split_count
	type
	weight_factor
	energy
	detector_angle
	element_scatter
	data
	element_number

Detailed Description

Cut file_path object for when reading cut files is necessary.

Constructor & Destructor Documentation

def Modules.CutFile.CutFile.__init__	(		self,
			directory = None,
			elem_loss = False,
			weight_factor = 1.0,
			split_number = 0,
			split_count = 1
	)

Inits cut file_path object.

Args:
    directory: String representing cut directory.
    elem_loss: Boolean representing whether cut file_path is made from
       elemental losses splits.
    weight_factor: Float representing element weight factor. 
    split_number: Integer. Required for Elemental Losses, do not overwrite
          splits.
    split_count: Integer. Required for Elemental Losses, total count of 
         splits.

Member Function Documentation

def Modules.CutFile.CutFile.copy_info	(		self,
			cut_file,
			data,
			additional_weight_factor = 1.0
	)

Copy information from cut file_path object into this.

Args:
    cut_file: CutFile class object.
    data: List of data points.
    additional_weight_factor: Float

def Modules.CutFile.CutFile.load_file	(		self,
			file
	)

Load and parse cut file_path.

Args:
    file: String representing cut file.

def Modules.CutFile.CutFile.save	(		self,
			element_count = 0
	)

Save cut file_path.

Saves data points into cut file_path with meta information.

Args:
    element_count: Integer representing which selection was used of total
           count of same element and isotope selection. This is so
           that we do not overwrite first 2H selection with other
           2H selection.

def Modules.CutFile.CutFile.set_info	(		self,
			selection,
			data
	)

Set selection information and data into CutFile.

Args:
    selection: Selection class object.
    data: Lists of data points.

def Modules.CutFile.CutFile.split	(		self,
			reference_cut,
			splits = 10,
			save = True
	)

Splits cut file into X splits based on reference cut.

Args:
    reference_cut: Cut file (of heavy element) which is used split.
    splits: Integer determining how many splits is cut splitted to.
    save: Boolean deciding whether or not to save splits.
    
Return:
    Returns a list containing lists of the cut's splits' values.

---

The documentation for this class was generated from the following file:

• C:/MyTemp/ibasoft/ibasoft/Modules/CutFile.py