resistics.common.checks module¶
-
resistics.common.checks.consistentChans(chan: str) → str[source]¶ Convert channels to ensure consistency
- Parameters
- chanstr
Channel name
- Returns
- outstr
Converted channel name
-
resistics.common.checks.elecChannelsList() → List[source]¶ List of acceptable electric channels
- Returns
- outList
List of acceptable electric channels
-
resistics.common.checks.isElectric(chan: str) → bool[source]¶ Check if channel is electric
- Parameters
- chanstr
Channel name
- Returns
- outbool
True if channel is electric
-
resistics.common.checks.isMagnetic(chan: str) → bool[source]¶ Check if channel is magnetic
- Parameters
- chanstr
Channel name
- Returns
- outbool
True if channel is magnetic
-
resistics.common.checks.magChannelsList() → List[source]¶ List of acceptable magnetic channels
- Returns
- outList
List of acceptable magnetic channels
-
resistics.common.checks.parseKeywords(default: Dict[str, Any], keywords: Dict[str, Any], printkw: bool = True)[source]¶ General print to terminal
- Parameters
- defaultDict[str, Any]
Dictionary of default parameters
- keywordsDict[str, Any]
Dictionary of optional keywords
- printkwbool
Print out the keywords
- Returns
- Dict[str, Any]
The dictionary with the appropriate defaults overwritten by keyword arguments