Skip to content

← deprecated package

CreateIdentity

Create a two-dimensional array that is an identity matrix, optionally with a shifted diagonal.

This node is deprecated; use Identity Matrix instead. The node supports alternative compute backends, which can be used to speed up processing. More Info... Version 1.0.0

Ports/Properties

array

Output array.

  • verbose name: Array
  • default value: None
  • port type: DataPort
  • value type: AnyArray (can be None)
  • data direction: OUT

like

Optional template array.

  • verbose name: Like
  • default value: None
  • port type: DataPort
  • value type: AnyArray (can be None)
  • data direction: IN

rows

Number of rows.

  • verbose name: Rows
  • default value: None
  • port type: IntPort
  • value type: int

columns

Optionally the number of columns, if different from rows.

  • verbose name: Columns
  • default value: None
  • port type: IntPort
  • value type: int (can be None)

offset

Optional offset of the diagonal from the main diagonal. A positive value places the diagonal above the main diagonal, and a negative value places it below the main diagonal.

  • verbose name: Offset
  • default value: 0
  • port type: IntPort
  • value type: int (can be None)

backend

Optional compute backend to use. Keep is the current default, which resolves to that of the template array if one is provided and otherwise numpy unless overridden. Numpy is the standard CPU backend that underpins most of NeuroPype's operations. The others require one or more GPUs to be present on the system, except for torch-cpu. For best performance, keep all arrays that interact with each other (via processing nodes) on the same backend.

  • verbose name: Backend
  • default value: keep
  • port type: EnumPort
  • value type: str (can be None)

precision

Numeric precision to use. Keep resolves to the precision of the template array if one is provided, and otherwise to the current default (usually 64-bit). Can be reduced to save memory (e.g. if running on GPU).

  • verbose name: Precision
  • default value: keep
  • port type: EnumPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)