Skip to content

ab_block_aperture

ab_block_aperture

Block Aperture (AB) logic.

BlockApertureBegin

Bases: CommandToken

4.11 Block Aperture (AB).
4.11.1 Overview of block apertures

The AB command creates a block aperture. The command stream between the opening and closing AB command defines a block aperture which is stored in the aperture dictionary. Thus the AB commands add an aperture to the dictionary directly, without needing an AD command. The LM, LR, LS and LP commands affect the flashes of block apertures as any other aperture: when a block aperture is flashed, it is first transformed according to the transformation parameters in the graphics state and then added to the object stream.

The origin of the block aperture is the (0,0) point of the file.

A block aperture is not a single graphical object but a set of objects. While a standard or macro aperture always adds a single graphical object to the stream, a block aperture can add any number of objects, each with their own polarity. Standard and macro apertures always have a single polarity while block apertures can contain both dark and clear objects.

If the polarity is dark (LPD) when the block is flashed then the block aperture is inserted as is. If the polarity is clear (LPC) then the polarity of all objects in the block is toggled (clear becomes dark, and dark becomes clear). This toggle propagates through all nesting levels. In the following example the polarity of objects in the flash of block D12 will be toggled.

%ABD12*%
…
%AB*%
…
D12*
%LPC*%
X-2500000Y-1000000D03*

A D03 of a block aperture updates the current point but otherwise leaves the graphics state unmodified, as with any other aperture.

See section 4.11 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class BlockApertureBegin(CommandToken):
    """## 4.11 Block Aperture (AB).

    ### 4.11.1 Overview of block apertures

    The AB command creates a block aperture. The command stream between the opening and
    closing AB command defines a block aperture which is stored in the aperture dictionary. Thus
    the AB commands add an aperture to the dictionary directly, without needing an AD command.
    The LM, LR, LS and LP commands affect the flashes of block apertures as any other aperture:
    when a block aperture is flashed, it is first transformed according to the transformation
    parameters in the graphics state and then added to the object stream.

    The origin of the block aperture is the (0,0) point of the file.

    A block aperture is not a single graphical object but a set of objects. While a standard or macro
    aperture always adds a single graphical object to the stream, a block aperture can add any
    number of objects, each with their own polarity. Standard and macro apertures always have a
    single polarity while block apertures can contain both dark and clear objects.

    If the polarity is dark (LPD) when the block is flashed then the block aperture is inserted as is. If
    the polarity is clear (LPC) then the polarity of all objects in the block is toggled (clear becomes
    dark, and dark becomes clear). This toggle propagates through all nesting levels. In the
    following example the polarity of objects in the flash of block D12 will be toggled.

    ```gerber
    %ABD12*%
    …
    %AB*%
    …
    D12*
    %LPC*%
    X-2500000Y-1000000D03*
    ```

    A D03 of a block aperture updates the current point but otherwise leaves the graphics state
    unmodified, as with any other aperture.

    ---

    See section 4.11 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=111)

    """  # noqa: E501

    def __init__(self, string: str, location: int, identifier: ApertureID) -> None:
        super().__init__(string, location)
        self.identifier = identifier

    @classmethod
    def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
        """Create instance of this class.

        Created to be used as callback in `ParserElement.set_parse_action()`.
        """
        return cls(string, location, ApertureID(tokens["aperture_identifier"]))

    def update_drawing_state(
        self,
        state: State,
        backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Update drawing state."""
        handle = backend.create_aperture_handle(self.identifier)
        with handle:
            # Must be included to initialize drawing target.
            pass
        frozen_handle = handle.get_public_handle()

        new_aperture_dict = {**state.apertures}
        new_aperture_dict[self.identifier] = frozen_handle

        return (
            state.model_copy(
                update={
                    "apertures": new_aperture_dict,
                },
            ),
            (),
        )

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().begin_block_aperture.pre_parser_visit_token(self, context)
        context.get_hooks().begin_block_aperture.on_parser_visit_token(self, context)
        context.get_hooks().begin_block_aperture.post_parser_visit_token(self, context)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",  # noqa: ARG002
    ) -> str:
        """Get gerber code represented by this token."""
        return f"{indent}AB{self.identifier.get_gerber_code()}"

new classmethod 

new(
    string: str, location: int, tokens: ParseResults
) -> Self

Create instance of this class.

Created to be used as callback in ParserElement.set_parse_action().

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
66
67
68
69
70
71
72
@classmethod
def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
    """Create instance of this class.

    Created to be used as callback in `ParserElement.set_parse_action()`.
    """
    return cls(string, location, ApertureID(tokens["aperture_identifier"]))

update_drawing_state 

update_drawing_state(
    state: State, backend: Backend
) -> Tuple[State, Iterable[DrawCommand]]

Update drawing state.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def update_drawing_state(
    self,
    state: State,
    backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Update drawing state."""
    handle = backend.create_aperture_handle(self.identifier)
    with handle:
        # Must be included to initialize drawing target.
        pass
    frozen_handle = handle.get_public_handle()

    new_aperture_dict = {**state.apertures}
    new_aperture_dict[self.identifier] = frozen_handle

    return (
        state.model_copy(
            update={
                "apertures": new_aperture_dict,
            },
        ),
        (),
    )

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
 98
 99
100
101
102
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().begin_block_aperture.pre_parser_visit_token(self, context)
    context.get_hooks().begin_block_aperture.on_parser_visit_token(self, context)
    context.get_hooks().begin_block_aperture.post_parser_visit_token(self, context)

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
104
105
106
107
108
109
110
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return f"{indent}AB{self.identifier.get_gerber_code()}"

BlockApertureEnd

Bases: CommandToken

4.11 Block Aperture (AB).
4.11.1 Overview of block apertures

The AB command creates a block aperture. The command stream between the opening and closing AB command defines a block aperture which is stored in the aperture dictionary. Thus the AB commands add an aperture to the dictionary directly, without needing an AD command. The LM, LR, LS and LP commands affect the flashes of block apertures as any other aperture: when a block aperture is flashed, it is first transformed according to the transformation parameters in the graphics state and then added to the object stream.

The origin of the block aperture is the (0,0) point of the file.

A block aperture is not a single graphical object but a set of objects. While a standard or macro aperture always adds a single graphical object to the stream, a block aperture can add any number of objects, each with their own polarity. Standard and macro apertures always have a single polarity while block apertures can contain both dark and clear objects.

If the polarity is dark (LPD) when the block is flashed then the block aperture is inserted as is. If the polarity is clear (LPC) then the polarity of all objects in the block is toggled (clear becomes dark, and dark becomes clear). This toggle propagates through all nesting levels. In the following example the polarity of objects in the flash of block D12 will be toggled.

%ABD12*%
…
%AB*%
…
D12*
%LPC*%
X-2500000Y-1000000D03*

A D03 of a block aperture updates the current point but otherwise leaves the graphics state unmodified, as with any other aperture.

See section 4.11 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
class BlockApertureEnd(CommandToken):
    """## 4.11 Block Aperture (AB).

    ### 4.11.1 Overview of block apertures

    The AB command creates a block aperture. The command stream between the opening and
    closing AB command defines a block aperture which is stored in the aperture dictionary. Thus
    the AB commands add an aperture to the dictionary directly, without needing an AD command.
    The LM, LR, LS and LP commands affect the flashes of block apertures as any other aperture:
    when a block aperture is flashed, it is first transformed according to the transformation
    parameters in the graphics state and then added to the object stream.

    The origin of the block aperture is the (0,0) point of the file.

    A block aperture is not a single graphical object but a set of objects. While a standard or macro
    aperture always adds a single graphical object to the stream, a block aperture can add any
    number of objects, each with their own polarity. Standard and macro apertures always have a
    single polarity while block apertures can contain both dark and clear objects.

    If the polarity is dark (LPD) when the block is flashed then the block aperture is inserted as is. If
    the polarity is clear (LPC) then the polarity of all objects in the block is toggled (clear becomes
    dark, and dark becomes clear). This toggle propagates through all nesting levels. In the
    following example the polarity of objects in the flash of block D12 will be toggled.

    ```gerber
    %ABD12*%
    …
    %AB*%
    …
    D12*
    %LPC*%
    X-2500000Y-1000000D03*
    ```

    A D03 of a block aperture updates the current point but otherwise leaves the graphics state
    unmodified, as with any other aperture.

    ---

    See section 4.11 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=111)

    """  # noqa: E501

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().end_block_aperture.pre_parser_visit_token(self, context)
        context.get_hooks().end_block_aperture.on_parser_visit_token(self, context)
        context.get_hooks().end_block_aperture.post_parser_visit_token(self, context)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",  # noqa: ARG002
    ) -> str:
        """Get gerber code represented by this token."""
        return f"{indent}AB"

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
156
157
158
159
160
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().end_block_aperture.pre_parser_visit_token(self, context)
    context.get_hooks().end_block_aperture.on_parser_visit_token(self, context)
    context.get_hooks().end_block_aperture.post_parser_visit_token(self, context)

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ab_block_aperture.py 
162
163
164
165
166
167
168
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return f"{indent}AB"