|
|
`arpesbin.arpesconfig` is a class for storing and managing per-file config settings for analysis.
|
|
|
|
|
|
|
|
|
Instantiation
|
|
|
---
|
|
|
`arpesbin.arpesconfig(filename)`
|
|
|
|
|
|
`arpesbin.arpesconfig(_,Name,Value)`
|
|
|
|
|
|
`filename` can be a full path or a relative path from the current folder, or the name of a file on MATLAB's path.
|
|
|
---
|
|
|
`arpesbin.arpesconfig(filename)` Where `filename` can be a full path or a relative path from the current folder, or the name of a file on MATLAB's path.
|
|
|
If the file has the extension '.json' it will treat that JSON as a saved config file saved by arpesconfig.
|
|
|
If the file has the extension '.nxs' it will treat it as an HDF5 scientific data format file generated by Diamond i05, storing the data generated by the experiment.
|
|
|
If the file has any other extension it will be treated as if it had the .nxs' extension
|
|
|
|
|
|
`Name,Value` can take name-value pairs in MATLAB's standard format. A full list is below.
|
|
|
---
|
|
|
`arpesbin.arpesconfig(_,Name,Value)` takes name-value pairs in MATLAB's standard format. A full list is below.
|
|
|
|
|
|
| Name | ValueType| Default | Description |
|
|
|
| ------ | ------ | ------- | ------- |
|
... | ... | @@ -24,3 +29,47 @@ If the file has any other extension it will be treated as if it had the .nxs' ex |
|
|
| maxEnergy| `scalar` | 1000| largest energy to consider when converting data. Use to speed up calculations|
|
|
|
| shiftTheta| `scalar` | 0| fixed offset to angle to apply before converting data into k-space|
|
|
|
| shiftSapolar| `scalar` | 0| fixed offset to angle to apply before converting data into k-space|
|
|
|
|
|
|
Methods
|
|
|
---
|
|
|
|
|
|
---
|
|
|
|
|
|
---
|
|
|
|
|
|
Usage
|
|
|
---
|
|
|
|
|
|
JSON
|
|
|
---
|
|
|
An example JSON file. These can be edited manually if one is careful.
|
|
|
;;;
|
|
|
{
|
|
|
"version": "0.3",
|
|
|
"file_name": "i05-98350.nxs",
|
|
|
"file_location": "Z:\\ColdeaAGroup\\Students\\KylieM\\Data\\ARPES\\datafiles",
|
|
|
"gold_file_name": "i05-98343-Ef.dat",
|
|
|
"gold_file_location": "Z:\\ColdeaAGroup\\Students\\KylieM\\Data\\ARPES",
|
|
|
"deadpixel_file_name": "deadPixels2018.dat",
|
|
|
"deadpixel_file_location": "",
|
|
|
"shifts": {
|
|
|
"theta": -0.6,
|
|
|
"sapolar": 0
|
|
|
},
|
|
|
"limits": {
|
|
|
"constraint": {
|
|
|
"theta": {
|
|
|
"min": -10,
|
|
|
"max": 10
|
|
|
},
|
|
|
"energy": {
|
|
|
"min": 51.4,
|
|
|
"max": 51.51
|
|
|
}
|
|
|
},
|
|
|
"label": "Default",
|
|
|
"units": "si"
|
|
|
},
|
|
|
"bands": []
|
|
|
}
|
|
|
;;; |