tedana.io.OutputGenerator.get_name

OutputGenerator.get_name(description, **kwargs)

Generate a file full path to simplify file output.

Parameters:

• description (str) – The description of the file. Must be a key in self.config.

• kwargs (keyword arguments) – Additional arguments used to format the base filename string. The most common is echo.

Returns:

name (str) – The full path for the filename.

Notes

This function uses kwargs to allow us to match named format specifiers in a configuration with a variable passed to this function. get_fields simplifies this process by creating a set of name variables based on the configuration which we expect to match a passed variable name, and then we fill in the value.