setFnPlt(self,
fn_plt,
fn_suffix='
' ,
fn_subfolder='
' )
| source code
|
Create a plot filename. The base filename (fn_plt) defines which of 3
cases is requested:
1) path is given, and the object has fn_add_star set to 1. 2) path is
given, and the object has fn_add_star set to 0. 3) path is not given, in
which case the star name is never added (it is included in the default
folder name)
In all cases, a base filename must be given, and a suffix can be
defined in addition.
Returns empty string if fn_plt is not defined or empty.
- Parameters:
fn_plt (string) - A plot filename that can be given to each plotting sub method, or
through the cfg file (managed by the sub method). If not given,
each sub method defines a default. This includes the path if
required.
fn_suffix (str) - An optional suffix to be appended to the filename
(default: '')
fn_subfolder (str) - An additional subfolder in the default self.pplot can be added.
Not used when path is included in fn_plt.
(default: '')
- Returns: str
- The full path + filename without extension is returned.
|