Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

ScanImage

...

requires

...

an

...

initialization

...

(INI)

...

file,

...

usually

...

named

...

standard.ini

...

,

...

to

...

be

...

specified

...

at

...

startup.

...

This

...

file

...

initializes

...

state

...

variables

...

for

...

ScanImage

...

that

...

are

...

considered

...

to

...

be

...

invariant

...

with

...

respect

...

to

...

experiment

...

or

...

user

...

employing

...

the

...

ScanImage

...

installation

...

(a

...

'rig').

...

Typically

...

there

...

is

...

only

...

one

...

INI

...

file

...

per

...

'rig'.

...

The

...

INI

...

file

...

should

...

generally

...

be

...

stored

...

in

...

the

...

same

...

directory

...

with

...

one

...

or

...

more

...

user

...

(USR)

...

files.

...

On

...

startup,

...

ScanImage

...

prompts

...

for

...

a

...

USR

...

file

...

to

...

be

...

selected.

...

If

...

one

...

is

...

chosen,

...

then

...

ScanImage

...

loads

...

the

...

standard.ini

...

file

...

located

...

in

...

the

...

same

...

directory,

...

if

...

found.

...

(info) ScanImage only prompts to directly select an INI file if 1) no USR file is specified or 2) no file named standard.ini is found in the selected USR file's directory.

Tip
titleFirst Time Starting ScanImage?

The first time running ScanImage, one will not have a USR file configured yet. When prompted to select a USR file, 'Cancel' should thus be selected. Then ScanImage will prompt for an INI file – the configured standard.ini file should then be selected. To avoid this double prompting going forward, it is highly recommended that users save a USR file to load on future startups.

Configuring the INI File

Each release of ScanImage (beginning with ScanImage r3.5) contains a file standard_model.ini located in the directory 'ScanImage\init_files' (and also provided below).

The user should:

  1. Copy this standard_model.ini file to the desired INI (and USR) file directory (e.g. C:\Data\Config\ScanImage)

...

  1. Rename the file to standard.ini

...

  1. .

...

  1. Edit the

...

  1. file

...

  1. as

...

  1. appropriate

...

  1. for the hardware and experimental requirements of the rig.

(tick) The standard_model.ini

...

file

...

contains

...

comments

...

which

...

document

...

the

...

meaning

...

of

...

each

...

of

...

the

...

variables.

...


(warning) The INI file parser is whitespace sensitive. The format <VARNAME>=<VARVALUE>

...

must

...

be

...

strictly

...

followed,

...

i.e.

...

no

...

space

...

to

...

left

...

or

...

right

...

of

...

the

...

equal

...

sign

...

Find

...

below

...

the

...

standard

...

_model.ini

...

file

...

for

...

each

...

ScanImage

...

release and a note for each indicating the changes, if any, compared to the prior release:

Center

Info
titleMultiple INI Files (Rarely Needed)

As a general rule, only one INI file should be required per 'rig' (ScanImage installation). In rare circumstances, however, a rig might require more than one INI file. For instance, if two users – or two types of experiment – require that one of the variables contained in the INI file must differ from session to session. In such cases, there are two options:

  1. Maintain separate folders for each INI file, each named standard.ini. Each folder contains the USR file(s) associated with that INI configuration. In this case, selecting the USR file on startup will cause the appropriate INI file to be loaded.
  2. Name the INI files something other than standard.ini (e.g. rigConfig1.ini and rigConfig2.ini) and then select the particular INI file when prompted, after selecting the desired USR file (if any) on startup.
and further explanation of each of the variables therein: {table-data:INI File Models|order=descending} || ScanImage Version || Model INI File || Variable Descriptions || | {text-data:ScanImageVersion}{text-data} | {attachment-data:ModelINIFile}{attachment-data} | {text-data:INIInfoPage}{text-data} | {table-data} {note}In rare circumstances, a rig might require more than one INI file, if one of the variables contained in the INI file must differ from session to session. In such cases, either the INI file should be named something other than _standard.ini_ and then in{note} {info}ScanImage 3.5 changes somewhat the way the INI file is loaded at startup. This is described in the section about [Initialization (INI) File Handling].{info} A subset of the INI file variables -- termed the *Rig Configuration* variables -- are demarcated at the beginning of the INI file. Rig Configuration variables are those which may require modification for a new ScanImage installation. These variables are rig-specific, and are not associated with either configuration (CFG) or user (USR) files. The values for these variables are not modified/modifiable during ScanImage program operation. h5. Rig Configuration Variable Reference This section serves as a reference to the new and notable _Rig Configuration_ variables in ScanImage 3.5. {link-window:ScanImage Files^r3_5_standardINI_rigConfig.txt|target="_blank"}View _Rig Configuration_ Section of Model INI File{link-window}{center} Users should adjust the Rig Configuration values to match the hardware and experimental requirements for their rig, creating their own _standard.ini_ file.