virtual_knitting_machine.machine_components.needles.Sheet_Needle module
Module for managing sheet needle construction for multi-sheet knitting operations.
This module provides classes for managing needles in a layered gauging schema used in multi-sheet knitting. It includes the Sheet_Needle class which extends the base Needle class to support gauge-based positioning, and the Slider_Sheet_Needle class for slider operations within sheets.
- class Sheet_Needle(is_front, sheet_pos, sheet, gauge)[source]
Bases:
NeedleA needle class for managing needles in a layered gauging schema.
Sheet needles are used in multi-sheet knitting where multiple layers of knitting are created simultaneously. This class extends the base Needle class to provide sheet-aware positioning and operations.
- recorded_loops
List of loops that have been recorded for this needle.
- Type:
- property gauge: int
Get the gauge currently being used for knitting.
- Returns:
The gauge (number of layers) currently knitting in.
- Return type:
- property sheet_pos: int
Get the position of the needle within its sheet.
- Returns:
The position of the needle within the sheet.
- Return type:
- property sheet: int
Get the sheet number of this needle.
- Returns:
The position of the sheet in the gauge.
- Return type:
- static get_sheet_pos(actual_pos, gauge)[source]
Get the sheet position from an actual needle position at a given gauge.
- static get_sheet(actual_pos, sheet_pos, gauge)[source]
Get the sheet number from needle position and sheet position at a given gauge.
- static get_actual_pos(sheet_pos, sheet, gauge)[source]
Get the actual needle position from sheet needle components.
- offset_in_sheet(offset)[source]
Get a needle offset within the same sheet.
- Parameters:
offset (int) – Number of sheet positions to move.
- Returns:
The needle offset by the given value in the sheet (not actual needle positions).
- Return type:
- main_needle()[source]
Get the non-slider needle at this needle position.
- Returns:
The non-slider needle at this needle position. If this is not a slider, this instance is returned.
- Return type:
- gauge_neighbors()[source]
Get list of needles that neighbor this needle in other sheets of the same gauge.
- Returns:
List of needles that neighbor this loop in other gauges.
- Return type:
- __add__(other)[source]
Add to this sheet needle’s position.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to add.
- Returns:
New sheet needle with the sum position.
- Return type:
- __radd__(other)[source]
Right-hand add operation for sheet needle.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to add.
- Returns:
New sheet needle with the sum position.
- Return type:
- __sub__(other)[source]
Subtract from this sheet needle’s position.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to subtract.
- Returns:
New sheet needle with the difference position.
- Return type:
- __rsub__(other)[source]
Right-hand subtract operation for sheet needle.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to subtract from.
- Returns:
New sheet needle with the difference position.
- Return type:
- __eq__(other)
Check equality with another needle.
- __hash__()
Return hash value for the needle.
- Returns:
Hash value based on position (negative for back needles).
- Return type:
- __index__()
Return index representation of the needle position.
- Returns:
The needle position as an index.
- Return type:
- __int__()
Return integer representation of the needle position.
- Returns:
The needle position.
- Return type:
- __lshift__(other)
Left shift operation (equivalent to subtraction).
- __lt__(other)
Compare if this needle is less than another needle or number.
- Parameters:
other (Needle | int | float) – The other needle or number to compare with.
- Returns:
True if this needle’s position is less than the other value. If the needles are at the same location but in opposite positions (back vs. front), the front needle is considered less than the back. This orders needles as front-to-back in a leftward carriage pass.
- Return type:
- Raises:
TypeError – If other is not a Needle or number.
- __repr__()
Return string representation of the needle.
- Returns:
String representation of the needle.
- Return type:
- __rlshift__(other)
Right-hand left shift operation.
- __rrshift__(other)
Right-hand right shift operation.
- __rshift__(other)
Right shift operation (equivalent to addition).
- __str__()
Return string representation of the needle.
- Returns:
String representation (e.g., ‘f5’ for front needle at position 5).
- Return type:
- active_floats()
Get active floats connecting to loops on this needle.
- Returns:
Dictionary of loops that are active keyed to active yarn-wise neighbors. Each key-value pair represents a directed float where key comes before value on the yarns in the system.
- Return type:
- add_loop(loop)
Add a loop to the set of currently held loops.
- Parameters:
loop (Machine_Knit_Loop) – Loop to add onto needle.
- Return type:
- add_loops(loops)
Add multiple loops to the held set.
- Parameters:
loops (list[Machine_Knit_Loop]) – List of loops to place onto needle.
- Return type:
- at_racking_comparison(other, rack=0, all_needle_racking=False)
Compare needle positions at a given racking.
- Parameters:
- Returns:
1 if self > other, 0 if equal, -1 if self < other.
- Return type:
Note
At an all needle racking, the front needle is always < the back needle, regardless of direction.
- drop()
Drop all held loops by releasing them from the needle.
- Returns:
The loops that were dropped.
- Return type:
- float_overlaps_needle(u, v)
Check if a float between two loops overlaps this needle’s position.
- Parameters:
u (Machine_Knit_Loop) – Machine_Knit_Loop at start of float.
v (Machine_Knit_Loop) – Machine_Knit_Loop at end of float.
- Returns:
True if the float between u and v overlaps the position of this needle.
- Return type:
- property has_loops: bool
Check if the needle is currently holding any loops.
- Returns:
True if needle is holding loops, False otherwise.
- Return type:
- property is_back: bool
Check if needle is on the back bed.
- Returns:
True if needle is on the back bed, False otherwise.
- Return type:
- property is_front: bool
Check if needle is on the front bed.
- Returns:
True if needle is on front bed, False otherwise.
- Return type:
- property is_slider: bool
Check if the needle is a slider needle.
- Returns:
True if the needle is a slider, False otherwise.
- Return type:
- static needle_at_racking_cmp(n1, n2, racking=0, all_needle_racking=False)
Static method to compare two needles at a given racking.
- Parameters:
- Returns:
1 if n1 > n2, 0 if equal, -1 if n1 < n2.
- Return type:
Note
At an all needle racking, the front needle is always < the back needle, regardless of direction.
- offset(offset)
Get a needle offset by the specified amount on the same bed.
- opposite()
Get the needle on the opposite bed at the same position.
- Returns:
The needle on the opposite bed at the same position.
- Return type:
- property position: int
Get the index position of the needle on the machine bed.
- Returns:
The index on the machine bed of the needle.
- Return type:
- property pull_direction: Pull_Direction
Get the direction this needle pulls loops during knit operations.
- Returns:
BtF (Back to Front) for front needles, FtB (Front to Back) for back needles.
- Return type:
Pull_Direction
- racked_position_on_front(rack)
Get the position of the needle on the front bed at a given racking.
- class Slider_Sheet_Needle(is_front, sheet_pos, sheet, gauge)[source]
Bases:
Sheet_Needle,Slider_NeedleA slider needle class for use in gauging schema.
This class combines the functionality of Sheet_Needle and Slider_Needle to provide slider needle capabilities within a multi-sheet knitting environment.
- __add__(other)
Add to this sheet needle’s position.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to add.
- Returns:
New sheet needle with the sum position.
- Return type:
- __eq__(other)
Check equality with another needle.
- __hash__()
Return hash value for the needle.
- Returns:
Hash value based on position (negative for back needles).
- Return type:
- __index__()
Return index representation of the needle position.
- Returns:
The needle position as an index.
- Return type:
- __int__()
Return integer representation of the needle position.
- Returns:
The needle position.
- Return type:
- __lshift__(other)
Left shift operation (equivalent to subtraction).
- __lt__(other)
Compare if this needle is less than another needle or number.
- Parameters:
other (Needle | int | float) – The other needle or number to compare with.
- Returns:
True if this needle’s position is less than the other value. If the needles are at the same location but in opposite positions (back vs. front), the front needle is considered less than the back. This orders needles as front-to-back in a leftward carriage pass.
- Return type:
- Raises:
TypeError – If other is not a Needle or number.
- __radd__(other)
Right-hand add operation for sheet needle.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to add.
- Returns:
New sheet needle with the sum position.
- Return type:
- __repr__()
Return string representation of the needle.
- Returns:
String representation of the needle.
- Return type:
- __rlshift__(other)
Right-hand left shift operation.
- __rrshift__(other)
Right-hand right shift operation.
- __rshift__(other)
Right shift operation (equivalent to addition).
- __rsub__(other)
Right-hand subtract operation for sheet needle.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to subtract from.
- Returns:
New sheet needle with the difference position.
- Return type:
- __str__()
Return string representation of the slider needle.
- Returns:
String representation with ‘s’ suffix (e.g., ‘fs5’ for front slider at position 5, ‘bs3’ for back slider at position 3).
- Return type:
- __sub__(other)
Subtract from this sheet needle’s position.
- Parameters:
other (Sheet_Needle | Needle | int) – The needle or integer to subtract.
- Returns:
New sheet needle with the difference position.
- Return type:
- active_floats()
Get active floats connecting to loops on this needle.
- Returns:
Dictionary of loops that are active keyed to active yarn-wise neighbors. Each key-value pair represents a directed float where key comes before value on the yarns in the system.
- Return type:
- add_loop(loop)
Add a loop to the set of currently held loops.
- Parameters:
loop (Machine_Knit_Loop) – Loop to add onto needle.
- Return type:
- add_loops(loops)
Add multiple loops to the held set.
- Parameters:
loops (list[Machine_Knit_Loop]) – List of loops to place onto needle.
- Return type:
- at_racking_comparison(other, rack=0, all_needle_racking=False)
Compare needle positions at a given racking.
- Parameters:
- Returns:
1 if self > other, 0 if equal, -1 if self < other.
- Return type:
Note
At an all needle racking, the front needle is always < the back needle, regardless of direction.
- drop()
Drop all held loops by releasing them from the needle.
- Returns:
The loops that were dropped.
- Return type:
- float_overlaps_needle(u, v)
Check if a float between two loops overlaps this needle’s position.
- Parameters:
u (Machine_Knit_Loop) – Machine_Knit_Loop at start of float.
v (Machine_Knit_Loop) – Machine_Knit_Loop at end of float.
- Returns:
True if the float between u and v overlaps the position of this needle.
- Return type:
- property gauge: int
Get the gauge currently being used for knitting.
- Returns:
The gauge (number of layers) currently knitting in.
- Return type:
- gauge_neighbors()
Get list of needles that neighbor this needle in other sheets of the same gauge.
- Returns:
List of needles that neighbor this loop in other gauges.
- Return type:
- static get_actual_pos(sheet_pos, sheet, gauge)
Get the actual needle position from sheet needle components.
- static get_sheet(actual_pos, sheet_pos, gauge)
Get the sheet number from needle position and sheet position at a given gauge.
- static get_sheet_pos(actual_pos, gauge)
Get the sheet position from an actual needle position at a given gauge.
- property has_loops: bool
Check if the needle is currently holding any loops.
- Returns:
True if needle is holding loops, False otherwise.
- Return type:
- property is_back: bool
Check if needle is on the back bed.
- Returns:
True if needle is on the back bed, False otherwise.
- Return type:
- property is_front: bool
Check if needle is on the front bed.
- Returns:
True if needle is on front bed, False otherwise.
- Return type:
- property is_slider: bool
Check if the needle is a slider needle.
- Returns:
Always returns True for Slider_Needle instances.
- Return type:
- main_needle()
Get the non-slider needle at this needle position.
- Returns:
The non-slider needle at this needle position. If this is not a slider, this instance is returned.
- Return type:
- static needle_at_racking_cmp(n1, n2, racking=0, all_needle_racking=False)
Static method to compare two needles at a given racking.
- Parameters:
- Returns:
1 if n1 > n2, 0 if equal, -1 if n1 < n2.
- Return type:
Note
At an all needle racking, the front needle is always < the back needle, regardless of direction.
- offset(offset)
Get a needle offset by the specified amount on the same bed.
- offset_in_sheet(offset)
Get a needle offset within the same sheet.
- Parameters:
offset (int) – Number of sheet positions to move.
- Returns:
The needle offset by the given value in the sheet (not actual needle positions).
- Return type:
- opposite()
Get the needle on the opposite bed at the same position.
- Returns:
The needle on the opposite bed at the same position.
- Return type:
- property position: int
Get the index position of the needle on the machine bed.
- Returns:
The index on the machine bed of the needle.
- Return type:
- property pull_direction: Pull_Direction
Get the direction this needle pulls loops during knit operations.
- Returns:
BtF (Back to Front) for front needles, FtB (Front to Back) for back needles.
- Return type:
Pull_Direction
- racked_position_on_front(rack)
Get the position of the needle on the front bed at a given racking.
- property sheet: int
Get the sheet number of this needle.
- Returns:
The position of the sheet in the gauge.
- Return type:
- property sheet_pos: int
Get the position of the needle within its sheet.
- Returns:
The position of the needle within the sheet.
- Return type: