summaryrefslogtreecommitdiff
path: root/gerber/utils.py
blob: 00b821b45a7ebfce553328b179d19f8a8de5235a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
111
112
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
169
170
171
172
173
174
175
176
177
178
#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Copyright 2014 Hamilton Kibbe <ham@hamiltonkib.be>

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
gerber.utils
============
**Gerber and Excellon file handling utilities**

This module provides utility functions for working with Gerber and Excellon
files.
"""


def parse_gerber_value(value, format=(2, 5), zero_suppression='trailing'):
    """ Convert gerber/excellon formatted string to floating-point number
    
    .. note::
        Format and zero suppression are configurable. Note that the Excellon 
        and Gerber formats use opposite terminology with respect to leading 
        and trailing zeros. The Gerber format specifies which zeros are 
        suppressed, while the Excellon format specifies which zeros are 
        included. This function uses the Gerber-file convention, so an 
        Excellon file in LZ (leading zeros) mode would use 
        `zero_suppression='trailing'` 
    
    
    Parameters
    ----------
    value : string
        A Gerber/Excellon-formatted string representing a numerical value.

    format :  tuple (int,int)
        Gerber/Excellon precision format expressed as a tuple containing: 
        (number of integer-part digits, number of decimal-part digits)

    zero_suppression : string
        Zero-suppression mode. May be 'leading' or 'trailing'

    Returns
    -------
    value : float
        The specified value as a floating-point number.
    
    """
    # Format precision
    integer_digits, decimal_digits = format
    MAX_DIGITS = integer_digits + decimal_digits
    
    # Absolute maximum number of digits supported. This will handle up to
    # 6:7 format, which is somewhat supported, even though the gerber spec
    # only allows up to 6:6
    if MAX_DIGITS > 13 or integer_digits > 6 or decimal_digits > 7:
        raise ValueError('Parser only supports precision up to 6:7 format')

    # Remove extraneous information
    value = value.strip()
    value = value.strip(' +')
    negative = '-' in value
    if negative:
        value = value.strip(' -')
        
    # Handle excellon edge case with explicit decimal. "That was easy!"
    if '.' in value:
        return float(value)
    
    digits = [digit for digit in '0' * MAX_DIGITS]
    offset = 0 if zero_suppression == 'trailing' else (MAX_DIGITS - len(value))
    for i, digit in enumerate(value):
        digits[i + offset] = digit
    
    
    result = float(''.join(digits[:integer_digits] + ['.'] + digits[integer_digits:]))
    return -1.0 * result if negative else result
    
    
def write_gerber_value(value, format=(2, 5), zero_suppression='trailing'):
    """ Convert a floating point number to a Gerber/Excellon-formatted string.
    
    .. note::
        Format and zero suppression are configurable. Note that the Excellon 
        and Gerber formats use opposite terminology with respect to leading 
        and trailing zeros. The Gerber format specifies which zeros are 
        suppressed, while the Excellon format specifies which zeros are 
        included. This function uses the Gerber-file convention, so an 
        Excellon file in LZ (leading zeros) mode would use 
        `zero_suppression='trailing'`
    
    Parameters
    ----------
    value : float
        A floating point value.

    format :  tuple (n=2)
        Gerber/Excellon precision format expressed as a tuple containing: 
        (number of integer-part digits, number of decimal-part digits)

    zero_suppression : string
        Zero-suppression mode. May be 'leading' or 'trailing'

    Returns
    -------
    value : string
        The specified value as a Gerber/Excellon-formatted string.
    """
    # Format precision
    integer_digits, decimal_digits = format
    MAX_DIGITS = integer_digits + decimal_digits
    
    if MAX_DIGITS > 13 or integer_digits > 6 or decimal_digits > 7:
        raise ValueError('Parser only supports precision up to 6:7 format')
    
    # negative sign affects padding, so deal with it at the end...
    negative =  value < 0.0
    if negative:
        value = -1.0 * value

    # Format string for padding out in both directions
    fmtstring = '%%0%d.0%df' % (MAX_DIGITS + 1, decimal_digits)

    digits = [val for val in fmtstring % value if val != '.']
    
    # Suppression... 
    if zero_suppression == 'trailing':
        while digits[-1] == '0':
            digits.pop()
    else:
        while digits[0] == '0':
            digits.pop(0)
        
    return ''.join(digits) if not negative else ''.join(['-'] + digits)
    


def decimal_string(value, precision=6):
    """ Convert float to string with limited precision
    
    Parameters
    ----------
    value : float
        A floating point value.

    precision :  
        Maximum number of decimal places to print

    Returns
    -------
    value : string
        The specified value as a  string.
    
    """
    floatstr = '%0.20g' % value
    integer = None
    decimal = None
    if '.' in floatstr:
        integer, decimal = floatstr.split('.') 
    elif ',' in floatstr:
        integer, decimal = floatstr.split(',') 
    if len(decimal) > precision:
        decimal = decimal[:precision]
    if integer or decimal:
        return ''.join([integer, '.', decimal])
    else:
        return int(floatstr)