enlighten.measurement.SaveOptions.SaveOptions Class Reference

Encapsulates the many options regarding how spectra are to be saved. More...

Public Member Functions
	__deepcopy__ (self, memo)
	allows deep-copying of Measurement
	__init__ (self, ctl)
	allow_rename_files (self)
	append (self)
	clear (self)
	filename_as_label (self)
	filename_template (self)
	focus_note (self)
	force_wavenumber (self)
	Called by Controller on first visit to Raman Mode.
	generate_display_path (self, path)
	generate_today_dir (self)
	get_directory (self)
	nicer than having plugins etc access attributes directly
	has_note (self)
	has_prefix (self)
	has_suffix (self)
	have_appended_serial (self, serial_number)
	Return whether we have appended data from the given serial number to the current file.
	init_checkbox (self, cb, option)
	init_from_config (self)
	Load initial state of SaveOptions from config file.
	label_template (self)
	load_raw (self)
	note (self)
	prefix (self)
	reset_appendage (self, pathname=None)
	We've started a new by-row CSV file which could theoretically be later appended to, so track some metadata about that.
	save_all_spectrometers (self)
	save_by_col (self)
	save_by_row (self)
	save_collated (self)
	save_csv (self)
	save_dark (self)
	save_dx (self)
	save_excel (self)
	save_json (self)
	save_pixel (self)
	save_processed (self)
	save_raw (self)
	save_reference (self)
	save_something (self)
	save_spc (self)
	save_text (self)
	save_wavelength (self)
	save_wavenumber (self)
	set_appended_serial (self, serial_number)
	Track that we've appended data from this serial number to the current file.
	suffix (self)
	update_filename_template (self)
	Check to see if template contains macros (which would allow the filename to change between measurements).
	update_location (self)
	Show the directory dialog selection, set the default save location to the selected directory.
	update_widgets (self)
	Update widgets and config state when:
	wrap_name (self, name, pre, post)

Static Public Member Functions
	get_default_configuration ()

Public Attributes
	append_pathname = None
	appended_serial_numbers = None
	bt_location = None
	cb_all = None
	cb_allow_rename = cfu.checkBox_allow_rename_files
	cb_append = None
	cb_collated = None
	cb_csv = None
	cb_dark = None
	cb_dx = None
	cb_excel = None
	cb_filename_as_label = None
	cb_json = None
	cb_load_raw = cfu.checkBox_load_raw
	cb_pixel = None
	cb_raw = None
	cb_reference = None
	cb_spc = None
	cb_text = None
	cb_wavelength = None
	cb_wavenumber = None
	ctl = ctl
	directory = None
str	last_filename_template = self.DEFAULT_FILENAME_TEMPLATE
	last_prefix = None
	last_suffix = None
	lb_location = None
	le_filename_template = None
	le_label_template = None
	le_note = None
	le_prefix = None
	le_suffix = None
int	line_number = 0
	multipart_suffix = None
	rb_by_col = None
	rb_by_row = None
bool	save_with_pixel = False
bool	save_with_raw = False
bool	save_with_wavelength = False
bool	save_with_wavenumber = False
	update_filename_template
	update_location
	update_widgets

Static Public Attributes
str	DEFAULT_FILENAME_TEMPLATE = "{measurement id}"
	these may not be blank
str	DEFAULT_LABEL_TEMPLATE = "{time} {serial_number}"
	these may not be blank

Detailed Description

Encapsulates the many options regarding how spectra are to be saved.

Constructor & Destructor Documentation

__init__()

enlighten.measurement.SaveOptions.SaveOptions.__init__	(		self,
			ctl )

Member Function Documentation

__deepcopy__()

enlighten.measurement.SaveOptions.SaveOptions.__deepcopy__	(		self,
			memo )

allows deep-copying of Measurement

allow_rename_files()

enlighten.measurement.SaveOptions.SaveOptions.allow_rename_files

(

self

)

append()

enlighten.measurement.SaveOptions.SaveOptions.append

(

self

)

clear()

enlighten.measurement.SaveOptions.SaveOptions.clear

(

self

)

filename_as_label()

enlighten.measurement.SaveOptions.SaveOptions.filename_as_label

(

self

)

filename_template()

enlighten.measurement.SaveOptions.SaveOptions.filename_template

(

self

)

focus_note()

enlighten.measurement.SaveOptions.SaveOptions.focus_note

(

self

)

force_wavenumber()

enlighten.measurement.SaveOptions.SaveOptions.force_wavenumber

(

self

)

Called by Controller on first visit to Raman Mode.

generate_display_path()

enlighten.measurement.SaveOptions.SaveOptions.generate_display_path	(		self,
			path )

generate_today_dir()

enlighten.measurement.SaveOptions.SaveOptions.generate_today_dir

(

self

)

get_default_configuration()

enlighten.measurement.SaveOptions.SaveOptions.get_default_configuration ( )

static

get_directory()

enlighten.measurement.SaveOptions.SaveOptions.get_directory

(

self

)

nicer than having plugins etc access attributes directly

has_note()

enlighten.measurement.SaveOptions.SaveOptions.has_note

(

self

)

has_prefix()

enlighten.measurement.SaveOptions.SaveOptions.has_prefix

(

self

)

has_suffix()

enlighten.measurement.SaveOptions.SaveOptions.has_suffix

(

self

)

have_appended_serial()

enlighten.measurement.SaveOptions.SaveOptions.have_appended_serial	(		self,
			serial_number )

Return whether we have appended data from the given serial number to the current file.

init_checkbox()

enlighten.measurement.SaveOptions.SaveOptions.init_checkbox	(		self,
			cb,
			option )

init_from_config()

enlighten.measurement.SaveOptions.SaveOptions.init_from_config

(

self

)

Load initial state of SaveOptions from config file.

label_template()

enlighten.measurement.SaveOptions.SaveOptions.label_template

(

self

)

load_raw()

enlighten.measurement.SaveOptions.SaveOptions.load_raw

(

self

)

note()

enlighten.measurement.SaveOptions.SaveOptions.note

(

self

)

prefix()

enlighten.measurement.SaveOptions.SaveOptions.prefix

(

self

)

reset_appendage()

enlighten.measurement.SaveOptions.SaveOptions.reset_appendage	(		self,
			pathname = None )

We've started a new by-row CSV file which could theoretically be later appended to, so track some metadata about that.

save_all_spectrometers()

enlighten.measurement.SaveOptions.SaveOptions.save_all_spectrometers

(

self

)

save_by_col()

enlighten.measurement.SaveOptions.SaveOptions.save_by_col

(

self

)

save_by_row()

enlighten.measurement.SaveOptions.SaveOptions.save_by_row

(

self

)

save_collated()

enlighten.measurement.SaveOptions.SaveOptions.save_collated

(

self

)

save_csv()

enlighten.measurement.SaveOptions.SaveOptions.save_csv

(

self

)

save_dark()

enlighten.measurement.SaveOptions.SaveOptions.save_dark

(

self

)

save_dx()

enlighten.measurement.SaveOptions.SaveOptions.save_dx

(

self

)

save_excel()

enlighten.measurement.SaveOptions.SaveOptions.save_excel

(

self

)

save_json()

enlighten.measurement.SaveOptions.SaveOptions.save_json

(

self

)

save_pixel()

enlighten.measurement.SaveOptions.SaveOptions.save_pixel

(

self

)

save_processed()

enlighten.measurement.SaveOptions.SaveOptions.save_processed

(

self

)

save_raw()

enlighten.measurement.SaveOptions.SaveOptions.save_raw

(

self

)

save_reference()

enlighten.measurement.SaveOptions.SaveOptions.save_reference

(

self

)

save_something()

enlighten.measurement.SaveOptions.SaveOptions.save_something

(

self

)

save_spc()

enlighten.measurement.SaveOptions.SaveOptions.save_spc

(

self

)

save_text()

enlighten.measurement.SaveOptions.SaveOptions.save_text

(

self

)

save_wavelength()

enlighten.measurement.SaveOptions.SaveOptions.save_wavelength

(

self

)

save_wavenumber()

enlighten.measurement.SaveOptions.SaveOptions.save_wavenumber

(

self

)

set_appended_serial()

enlighten.measurement.SaveOptions.SaveOptions.set_appended_serial	(		self,
			serial_number )

Track that we've appended data from this serial number to the current file.

This can guide decisions in whether certain metadata needs to be re-appended on successive writes.

suffix()

enlighten.measurement.SaveOptions.SaveOptions.suffix

(

self

)

update_filename_template()

enlighten.measurement.SaveOptions.SaveOptions.update_filename_template

(

self

)

Check to see if template contains macros (which would allow the filename to change between measurements).

[#429]

Todo

Note that we're not actually validating that the macro is valid; this is another reason to create a TemplateFeature.

update_location()

enlighten.measurement.SaveOptions.SaveOptions.update_location

(

self

)

Show the directory dialog selection, set the default save location to the selected directory.

update_widgets()

enlighten.measurement.SaveOptions.SaveOptions.update_widgets

(

self

)

Update widgets and config state when:

• user clicked on a SaveOption widget
• user selects a different spectrometer (might have different capabilities)
• user takes or clears a dark or reference

wrap_name()

enlighten.measurement.SaveOptions.SaveOptions.wrap_name	(		self,
			name,
			pre,
			post )

Member Data Documentation

append_pathname

enlighten.measurement.SaveOptions.SaveOptions.append_pathname = None

appended_serial_numbers

enlighten.measurement.SaveOptions.SaveOptions.appended_serial_numbers = None

bt_location

enlighten.measurement.SaveOptions.SaveOptions.bt_location = None

cb_all

enlighten.measurement.SaveOptions.SaveOptions.cb_all = None

cb_allow_rename

enlighten.measurement.SaveOptions.SaveOptions.cb_allow_rename = cfu.checkBox_allow_rename_files

cb_append

enlighten.measurement.SaveOptions.SaveOptions.cb_append = None

cb_collated

enlighten.measurement.SaveOptions.SaveOptions.cb_collated = None

cb_csv

enlighten.measurement.SaveOptions.SaveOptions.cb_csv = None

cb_dark

enlighten.measurement.SaveOptions.SaveOptions.cb_dark = None

cb_dx

enlighten.measurement.SaveOptions.SaveOptions.cb_dx = None

cb_excel

enlighten.measurement.SaveOptions.SaveOptions.cb_excel = None

cb_filename_as_label

enlighten.measurement.SaveOptions.SaveOptions.cb_filename_as_label = None

cb_json

enlighten.measurement.SaveOptions.SaveOptions.cb_json = None

cb_load_raw

enlighten.measurement.SaveOptions.SaveOptions.cb_load_raw = cfu.checkBox_load_raw

cb_pixel

enlighten.measurement.SaveOptions.SaveOptions.cb_pixel = None

cb_raw

enlighten.measurement.SaveOptions.SaveOptions.cb_raw = None

cb_reference

enlighten.measurement.SaveOptions.SaveOptions.cb_reference = None

cb_spc

enlighten.measurement.SaveOptions.SaveOptions.cb_spc = None

cb_text

enlighten.measurement.SaveOptions.SaveOptions.cb_text = None

cb_wavelength

enlighten.measurement.SaveOptions.SaveOptions.cb_wavelength = None

cb_wavenumber

enlighten.measurement.SaveOptions.SaveOptions.cb_wavenumber = None

ctl

enlighten.measurement.SaveOptions.SaveOptions.ctl = ctl

DEFAULT_FILENAME_TEMPLATE

enlighten.measurement.SaveOptions.SaveOptions.DEFAULT_FILENAME_TEMPLATE = "{measurement id}"

static

these may not be blank

DEFAULT_LABEL_TEMPLATE

enlighten.measurement.SaveOptions.SaveOptions.DEFAULT_LABEL_TEMPLATE = "{time} {serial_number}"

static

these may not be blank

directory

enlighten.measurement.SaveOptions.SaveOptions.directory = None

last_filename_template

enlighten.measurement.SaveOptions.SaveOptions.last_filename_template = self.DEFAULT_FILENAME_TEMPLATE

last_prefix

enlighten.measurement.SaveOptions.SaveOptions.last_prefix = None

last_suffix

enlighten.measurement.SaveOptions.SaveOptions.last_suffix = None

lb_location

enlighten.measurement.SaveOptions.SaveOptions.lb_location = None

le_filename_template

enlighten.measurement.SaveOptions.SaveOptions.le_filename_template = None

le_label_template

enlighten.measurement.SaveOptions.SaveOptions.le_label_template = None

le_note

enlighten.measurement.SaveOptions.SaveOptions.le_note = None

le_prefix

enlighten.measurement.SaveOptions.SaveOptions.le_prefix = None

le_suffix

enlighten.measurement.SaveOptions.SaveOptions.le_suffix = None

line_number

int enlighten.measurement.SaveOptions.SaveOptions.line_number = 0

multipart_suffix

enlighten.measurement.SaveOptions.SaveOptions.multipart_suffix = None

rb_by_col

enlighten.measurement.SaveOptions.SaveOptions.rb_by_col = None

rb_by_row

enlighten.measurement.SaveOptions.SaveOptions.rb_by_row = None

save_with_pixel

bool enlighten.measurement.SaveOptions.SaveOptions.save_with_pixel = False

save_with_raw

bool enlighten.measurement.SaveOptions.SaveOptions.save_with_raw = False

save_with_wavelength

bool enlighten.measurement.SaveOptions.SaveOptions.save_with_wavelength = False

save_with_wavenumber

bool enlighten.measurement.SaveOptions.SaveOptions.save_with_wavenumber = False

update_filename_template

enlighten.measurement.SaveOptions.SaveOptions.update_filename_template

update_location

enlighten.measurement.SaveOptions.SaveOptions.update_location

update_widgets

enlighten.measurement.SaveOptions.SaveOptions.update_widgets

---

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

• enlighten/measurement/SaveOptions.py