Datasets:

ArXiv:
License:
wsimson commited on
Commit
2b3c6e1
·
verified ·
1 Parent(s): c6f5c18

us4us: keep README + pipeline.yaml only (no per-dataset LICENSE/reconstruct.py)

Browse files
Files changed (2) hide show
  1. us4us/LICENSE +0 -395
  2. us4us/reconstruct.py +0 -421
us4us/LICENSE DELETED
@@ -1,395 +0,0 @@
1
- Attribution 4.0 International
2
-
3
- =======================================================================
4
-
5
- Creative Commons Corporation ("Creative Commons") is not a law firm and
6
- does not provide legal services or legal advice. Distribution of
7
- Creative Commons public licenses does not create a lawyer-client or
8
- other relationship. Creative Commons makes its licenses and related
9
- information available on an "as-is" basis. Creative Commons gives no
10
- warranties regarding its licenses, any material licensed under their
11
- terms and conditions, or any related information. Creative Commons
12
- disclaims all liability for damages resulting from their use to the
13
- fullest extent possible.
14
-
15
- Using Creative Commons Public Licenses
16
-
17
- Creative Commons public licenses provide a standard set of terms and
18
- conditions that creators and other rights holders may use to share
19
- original works of authorship and other material subject to copyright
20
- and certain other rights specified in the public license below. The
21
- following considerations are for informational purposes only, are not
22
- exhaustive, and do not form part of our licenses.
23
-
24
- Considerations for licensors: Our public licenses are
25
- intended for use by those authorized to give the public
26
- permission to use material in ways otherwise restricted by
27
- copyright and certain other rights. Our licenses are
28
- irrevocable. Licensors should read and understand the terms
29
- and conditions of the license they choose before applying it.
30
- Licensors should also secure all rights necessary before
31
- applying our licenses so that the public can reuse the
32
- material as expected. Licensors should clearly mark any
33
- material not subject to the license. This includes other CC-
34
- licensed material, or material used under an exception or
35
- limitation to copyright. More considerations for licensors:
36
- wiki.creativecommons.org/Considerations_for_licensors
37
-
38
- Considerations for the public: By using one of our public
39
- licenses, a licensor grants the public permission to use the
40
- licensed material under specified terms and conditions. If
41
- the licensor's permission is not necessary for any reason--for
42
- example, because of any applicable exception or limitation to
43
- copyright--then that use is not regulated by the license. Our
44
- licenses grant only permissions under copyright and certain
45
- other rights that a licensor has authority to grant. Use of
46
- the licensed material may still be restricted for other
47
- reasons, including because others have copyright or other
48
- rights in the material. A licensor may make special requests,
49
- such as asking that all changes be marked or described.
50
- Although not required by our licenses, you are encouraged to
51
- respect those requests where reasonable. More considerations
52
- for the public:
53
- wiki.creativecommons.org/Considerations_for_licensees
54
-
55
- =======================================================================
56
-
57
- Creative Commons Attribution 4.0 International Public License
58
-
59
- By exercising the Licensed Rights (defined below), You accept and agree
60
- to be bound by the terms and conditions of this Creative Commons
61
- Attribution 4.0 International Public License ("Public License"). To the
62
- extent this Public License may be interpreted as a contract, You are
63
- granted the Licensed Rights in consideration of Your acceptance of
64
- these terms and conditions, and the Licensor grants You such rights in
65
- consideration of benefits the Licensor receives from making the
66
- Licensed Material available under these terms and conditions.
67
-
68
-
69
- Section 1 -- Definitions.
70
-
71
- a. Adapted Material means material subject to Copyright and Similar
72
- Rights that is derived from or based upon the Licensed Material
73
- and in which the Licensed Material is translated, altered,
74
- arranged, transformed, or otherwise modified in a manner requiring
75
- permission under the Copyright and Similar Rights held by the
76
- Licensor. For purposes of this Public License, where the Licensed
77
- Material is a musical work, performance, or sound recording,
78
- Adapted Material is always produced where the Licensed Material is
79
- synched in timed relation with a moving image.
80
-
81
- b. Adapter's License means the license You apply to Your Copyright
82
- and Similar Rights in Your contributions to Adapted Material in
83
- accordance with the terms and conditions of this Public License.
84
-
85
- c. Copyright and Similar Rights means copyright and/or similar rights
86
- closely related to copyright including, without limitation,
87
- performance, broadcast, sound recording, and Sui Generis Database
88
- Rights, without regard to how the rights are labeled or
89
- categorized. For purposes of this Public License, the rights
90
- specified in Section 2(b)(1)-(2) are not Copyright and Similar
91
- Rights.
92
-
93
- d. Effective Technological Measures means those measures that, in the
94
- absence of proper authority, may not be circumvented under laws
95
- fulfilling obligations under Article 11 of the WIPO Copyright
96
- Treaty adopted on December 20, 1996, and/or similar international
97
- agreements.
98
-
99
- e. Exceptions and Limitations means fair use, fair dealing, and/or
100
- any other exception or limitation to Copyright and Similar Rights
101
- that applies to Your use of the Licensed Material.
102
-
103
- f. Licensed Material means the artistic or literary work, database,
104
- or other material to which the Licensor applied this Public
105
- License.
106
-
107
- g. Licensed Rights means the rights granted to You subject to the
108
- terms and conditions of this Public License, which are limited to
109
- all Copyright and Similar Rights that apply to Your use of the
110
- Licensed Material and that the Licensor has authority to license.
111
-
112
- h. Licensor means the individual(s) or entity(ies) granting rights
113
- under this Public License.
114
-
115
- i. Share means to provide material to the public by any means or
116
- process that requires permission under the Licensed Rights, such
117
- as reproduction, public display, public performance, distribution,
118
- dissemination, communication, or importation, and to make material
119
- available to the public including in ways that members of the
120
- public may access the material from a place and at a time
121
- individually chosen by them.
122
-
123
- j. Sui Generis Database Rights means rights other than copyright
124
- resulting from Directive 96/9/EC of the European Parliament and of
125
- the Council of 11 March 1996 on the legal protection of databases,
126
- as amended and/or succeeded, as well as other essentially
127
- equivalent rights anywhere in the world.
128
-
129
- k. You means the individual or entity exercising the Licensed Rights
130
- under this Public License. Your has a corresponding meaning.
131
-
132
-
133
- Section 2 -- Scope.
134
-
135
- a. License grant.
136
-
137
- 1. Subject to the terms and conditions of this Public License,
138
- the Licensor hereby grants You a worldwide, royalty-free,
139
- non-sublicensable, non-exclusive, irrevocable license to
140
- exercise the Licensed Rights in the Licensed Material to:
141
-
142
- a. reproduce and Share the Licensed Material, in whole or
143
- in part; and
144
-
145
- b. produce, reproduce, and Share Adapted Material.
146
-
147
- 2. Exceptions and Limitations. For the avoidance of doubt, where
148
- Exceptions and Limitations apply to Your use, this Public
149
- License does not apply, and You do not need to comply with
150
- its terms and conditions.
151
-
152
- 3. Term. The term of this Public License is specified in Section
153
- 6(a).
154
-
155
- 4. Media and formats; technical modifications allowed. The
156
- Licensor authorizes You to exercise the Licensed Rights in
157
- all media and formats whether now known or hereafter created,
158
- and to make technical modifications necessary to do so. The
159
- Licensor waives and/or agrees not to assert any right or
160
- authority to forbid You from making technical modifications
161
- necessary to exercise the Licensed Rights, including
162
- technical modifications necessary to circumvent Effective
163
- Technological Measures. For purposes of this Public License,
164
- simply making modifications authorized by this Section 2(a)
165
- (4) never produces Adapted Material.
166
-
167
- 5. Downstream recipients.
168
-
169
- a. Offer from the Licensor -- Licensed Material. Every
170
- recipient of the Licensed Material automatically
171
- receives an offer from the Licensor to exercise the
172
- Licensed Rights under the terms and conditions of this
173
- Public License.
174
-
175
- b. No downstream restrictions. You may not offer or impose
176
- any additional or different terms or conditions on, or
177
- apply any Effective Technological Measures to, the
178
- Licensed Material if doing so restricts exercise of the
179
- Licensed Rights by any recipient of the Licensed
180
- Material.
181
-
182
- 6. No endorsement. Nothing in this Public License constitutes or
183
- may be construed as permission to assert or imply that You
184
- are, or that Your use of the Licensed Material is, connected
185
- with, or sponsored, endorsed, or granted official status by,
186
- the Licensor or others designated to receive attribution as
187
- provided in Section 3(a)(1)(A)(i).
188
-
189
- b. Other rights.
190
-
191
- 1. Moral rights, such as the right of integrity, are not
192
- licensed under this Public License, nor are publicity,
193
- privacy, and/or other similar personality rights; however, to
194
- the extent possible, the Licensor waives and/or agrees not to
195
- assert any such rights held by the Licensor to the limited
196
- extent necessary to allow You to exercise the Licensed
197
- Rights, but not otherwise.
198
-
199
- 2. Patent and trademark rights are not licensed under this
200
- Public License.
201
-
202
- 3. To the extent possible, the Licensor waives any right to
203
- collect royalties from You for the exercise of the Licensed
204
- Rights, whether directly or through a collecting society
205
- under any voluntary or waivable statutory or compulsory
206
- licensing scheme. In all other cases the Licensor expressly
207
- reserves any right to collect such royalties.
208
-
209
-
210
- Section 3 -- License Conditions.
211
-
212
- Your exercise of the Licensed Rights is expressly made subject to the
213
- following conditions.
214
-
215
- a. Attribution.
216
-
217
- 1. If You Share the Licensed Material (including in modified
218
- form), You must:
219
-
220
- a. retain the following if it is supplied by the Licensor
221
- with the Licensed Material:
222
-
223
- i. identification of the creator(s) of the Licensed
224
- Material and any others designated to receive
225
- attribution, in any reasonable manner requested by
226
- the Licensor (including by pseudonym if
227
- designated);
228
-
229
- ii. a copyright notice;
230
-
231
- iii. a notice that refers to this Public License;
232
-
233
- iv. a notice that refers to the disclaimer of
234
- warranties;
235
-
236
- v. a URI or hyperlink to the Licensed Material to the
237
- extent reasonably practicable;
238
-
239
- b. indicate if You modified the Licensed Material and
240
- retain an indication of any previous modifications; and
241
-
242
- c. indicate the Licensed Material is licensed under this
243
- Public License, and include the text of, or the URI or
244
- hyperlink to, this Public License.
245
-
246
- 2. You may satisfy the conditions in Section 3(a)(1) in any
247
- reasonable manner based on the medium, means, and context in
248
- which You Share the Licensed Material. For example, it may be
249
- reasonable to satisfy the conditions by providing a URI or
250
- hyperlink to a resource that includes the required
251
- information.
252
-
253
- 3. If requested by the Licensor, You must remove any of the
254
- information required by Section 3(a)(1)(A) to the extent
255
- reasonably practicable.
256
-
257
- 4. If You Share Adapted Material You produce, the Adapter's
258
- License You apply must not prevent recipients of the Adapted
259
- Material from complying with this Public License.
260
-
261
-
262
- Section 4 -- Sui Generis Database Rights.
263
-
264
- Where the Licensed Rights include Sui Generis Database Rights that
265
- apply to Your use of the Licensed Material:
266
-
267
- a. for the avoidance of doubt, Section 2(a)(1) grants You the right
268
- to extract, reuse, reproduce, and Share all or a substantial
269
- portion of the contents of the database;
270
-
271
- b. if You include all or a substantial portion of the database
272
- contents in a database in which You have Sui Generis Database
273
- Rights, then the database in which You have Sui Generis Database
274
- Rights (but not its individual contents) is Adapted Material; and
275
-
276
- c. You must comply with the conditions in Section 3(a) if You Share
277
- all or a substantial portion of the contents of the database.
278
-
279
- For the avoidance of doubt, this Section 4 supplements and does not
280
- replace Your obligations under this Public License where the Licensed
281
- Rights include other Copyright and Similar Rights.
282
-
283
-
284
- Section 5 -- Disclaimer of Warranties and Limitation of Liability.
285
-
286
- a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
287
- EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
288
- AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
289
- ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
290
- IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
291
- WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
292
- PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
293
- ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
294
- KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
295
- ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
296
-
297
- b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
298
- TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
299
- NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
300
- INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
301
- COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
302
- USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
303
- ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
304
- DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
305
- IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
306
-
307
- c. The disclaimer of warranties and limitation of liability provided
308
- above shall be interpreted in a manner that, to the extent
309
- possible, most closely approximates an absolute disclaimer and
310
- waiver of all liability.
311
-
312
-
313
- Section 6 -- Term and Termination.
314
-
315
- a. This Public License applies for the term of the Copyright and
316
- Similar Rights licensed here. However, if You fail to comply with
317
- this Public License, then Your rights under this Public License
318
- terminate automatically.
319
-
320
- b. Where Your right to use the Licensed Material has terminated under
321
- Section 6(a), it reinstates:
322
-
323
- 1. automatically as of the date the violation is cured, provided
324
- it is cured within 30 days of Your discovery of the
325
- violation; or
326
-
327
- 2. upon express reinstatement by the Licensor.
328
-
329
- For the avoidance of doubt, this Section 6(b) does not affect any
330
- right the Licensor may have to seek remedies for Your violations
331
- of this Public License.
332
-
333
- c. For the avoidance of doubt, the Licensor may also offer the
334
- Licensed Material under separate terms or conditions or stop
335
- distributing the Licensed Material at any time; however, doing so
336
- will not terminate this Public License.
337
-
338
- d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
339
- License.
340
-
341
-
342
- Section 7 -- Other Terms and Conditions.
343
-
344
- a. The Licensor shall not be bound by any additional or different
345
- terms or conditions communicated by You unless expressly agreed.
346
-
347
- b. Any arrangements, understandings, or agreements regarding the
348
- Licensed Material not stated herein are separate from and
349
- independent of the terms and conditions of this Public License.
350
-
351
-
352
- Section 8 -- Interpretation.
353
-
354
- a. For the avoidance of doubt, this Public License does not, and
355
- shall not be interpreted to, reduce, limit, restrict, or impose
356
- conditions on any use of the Licensed Material that could lawfully
357
- be made without permission under this Public License.
358
-
359
- b. To the extent possible, if any provision of this Public License is
360
- deemed unenforceable, it shall be automatically reformed to the
361
- minimum extent necessary to make it enforceable. If the provision
362
- cannot be reformed, it shall be severed from this Public License
363
- without affecting the enforceability of the remaining terms and
364
- conditions.
365
-
366
- c. No term or condition of this Public License will be waived and no
367
- failure to comply consented to unless expressly agreed to by the
368
- Licensor.
369
-
370
- d. Nothing in this Public License constitutes or may be interpreted
371
- as a limitation upon, or waiver of, any privileges and immunities
372
- that apply to the Licensor or You, including from the legal
373
- processes of any jurisdiction or authority.
374
-
375
-
376
- =======================================================================
377
-
378
- Creative Commons is not a party to its public
379
- licenses. Notwithstanding, Creative Commons may elect to apply one of
380
- its public licenses to material it publishes and in those instances
381
- will be considered the “Licensor.” The text of the Creative Commons
382
- public licenses is dedicated to the public domain under the CC0 Public
383
- Domain Dedication. Except for the limited purpose of indicating that
384
- material is shared under a Creative Commons public license or as
385
- otherwise permitted by the Creative Commons policies published at
386
- creativecommons.org/policies, Creative Commons does not authorize the
387
- use of the trademark "Creative Commons" or any other trademark or logo
388
- of Creative Commons without its prior written consent including,
389
- without limitation, in connection with any unauthorized modifications
390
- to any of its public licenses or any other arrangements,
391
- understandings, or agreements concerning use of licensed material. For
392
- the avoidance of doubt, this paragraph does not form part of the
393
- public licenses.
394
-
395
- Creative Commons may be contacted at creativecommons.org.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
us4us/reconstruct.py DELETED
@@ -1,421 +0,0 @@
1
- # SPDX-License-Identifier: CC-BY-4.0
2
- """Reconstruct: transmission-mode attenuation FBP for the US4US ring-array USCT data.
3
-
4
- This is a full ring of point-source transmit elements with a receive sub-aperture
5
- on the far side of the ring (not surrounding the transmitter), so it's a
6
- transmission (amplitude-attenuation) acquisition, not reflection B-mode.
7
- `zea.ops.Beamform`/`USCTReflectivityDAS` don't apply, so this defines five custom
8
- operations (https://zea.readthedocs.io/en/latest/pipeline.html#custom-operations):
9
-
10
- TransmissionAttenuation -> ApertureRearrange -> ResortSinogram
11
- -> LinearizeDetectors -> FilteredBackprojection -> (built-in) GaussianBlur
12
-
13
- `LinearizeDetectors` mirrors the `linearize_detectors()` step us4us added to
14
- `reconstruction_example.py` on 2026-09-07: it resamples each projection from the
15
- ring's arc-spaced detectors onto the uniform chord axis that parallel-beam FBP
16
- assumes. Without it the reconstruction is radially distorted.
17
-
18
- `ApertureRearrange`'s `aperture_offset` (receive channel `k` of transmit `t` is
19
- ring element `(t + offset + k) mod 1024`, centered on the antipode) isn't
20
- documented anywhere in the file; confirmed via `validate_geometry` below, which
21
- predicts the direct-arrival sample from real element positions and compares it
22
- to the measured envelope peak.
23
-
24
- Usage:
25
- python reconstruct.py --input yezitronix-b-rg-1.2.hdf5
26
- python reconstruct.py --input s8_r.hdf5 --frame 0
27
- """
28
-
29
- import argparse
30
- import re
31
- from pathlib import Path
32
-
33
- import matplotlib.pyplot as plt
34
- import numpy as np
35
- from keras import ops
36
- from mpl_toolkits.axes_grid1 import make_axes_locatable
37
- from zea.internal.registry import ops_registry
38
- from zea.ops import Cast, GaussianBlur, Operation
39
-
40
- import zea
41
- from zea import Config, File, Pipeline
42
-
43
- HERE = Path(__file__).parent
44
- CONFIG = HERE / "pipeline.yaml"
45
-
46
- N_EL = 1024 # ring elements
47
- N_RX = 512 # receive sub-aperture width
48
- APERTURE_OFFSET = (N_EL - N_RX) // 2 # 256
49
- PROBE_RADIUS = 13e-2 # m; matches us4us's reconstruction_example.py and the measured geometry
50
-
51
-
52
- @ops_registry("transmission_attenuation")
53
- class TransmissionAttenuation(Operation):
54
- """Windowed peak RF amplitude per (tx, rx) pair, converted to attenuation via
55
- ``-20 * log10(amp / reference)``. ``reference=1.0`` is arbitrary units (no
56
- water-reference calibration)."""
57
-
58
- # Default is None (resolved below) rather than 1.0 so that an explicitly
59
- # passed value always differs from the signature default and is therefore
60
- # written into pipeline.yaml - zea omits params left at their default.
61
- def __init__(self, reference: float | None = None, **kwargs):
62
- super().__init__(**kwargs)
63
- self.reference = 1.0 if reference is None else reference
64
-
65
- def call(self, **kwargs):
66
- raw = kwargs[self.key] # (n_tx, n_ax, n_rx, n_ch)
67
- raw = ops.squeeze(raw, axis=-1) # (n_tx, n_ax, n_rx)
68
- n_ax = raw.shape[1]
69
- # `keras.ops.bartlett` requires its length argument to be a concrete
70
- # (non-traced) Python int even under jit, which a shape-derived value
71
- # here isn't - so the triangular window is built directly instead.
72
- i = ops.arange(n_ax, dtype="float32")
73
- half = (n_ax - 1) / 2.0
74
- window = (1.0 - ops.abs((i - half) / half))[None, :, None]
75
- amp = ops.max(ops.abs(raw * window), axis=1) # (n_tx, n_rx)
76
- att = -20 * ops.log10(amp / self.reference)
77
- return {self.output_key: att}
78
-
79
-
80
- @ops_registry("aperture_rearrange")
81
- class ApertureRearrange(Operation):
82
- """Cyclically re-indexes each transmit's receive columns to a consistent
83
- relative frame, so `ResortSinogram` can treat rows as consecutive projection
84
- angles. `aperture_offset` is not documented in the file — see module
85
- docstring."""
86
-
87
- def __init__(self, aperture_offset: int | None = None, **kwargs):
88
- super().__init__(**kwargs)
89
- self.aperture_offset = APERTURE_OFFSET if aperture_offset is None else aperture_offset
90
-
91
- def call(self, **kwargs):
92
- att = kwargs[self.key] # (n_tx, n_rx)
93
- n_tx, n_rx = att.shape
94
- rel_start = n_tx // 2 - self.aperture_offset
95
- rel_end = n_tx // 2 + self.aperture_offset
96
- tx = ops.arange(n_tx)
97
- rx_end = ops.mod(tx + rel_end, n_tx)
98
- rx_start = ops.mod(tx + rel_start, n_tx)
99
- shift = ops.where(rx_end < rx_start, rx_end + 1, 0) # (n_tx,)
100
- col = ops.mod(ops.arange(n_rx)[None, :] + shift[:, None], n_rx)
101
- rearranged = ops.take_along_axis(att, col, axis=1)
102
- return {self.output_key: rearranged}
103
-
104
-
105
- @ops_registry("resort_sinogram")
106
- class ResortSinogram(Operation):
107
- """Doubles angular sampling (n_tx -> 2*n_tx) and halves detector count
108
- (n_rx -> n_rx // 2) by interleaving receive channels across transmits, into a
109
- proper parallel-projection sinogram."""
110
-
111
- def call(self, **kwargs):
112
- att = kwargs[self.key] # (n_tx, n_rx)
113
- n_tx, n_rx = att.shape
114
- rx = ops.arange(n_rx // 2)
115
- tx = ops.arange(n_tx)
116
- RX, TX = ops.meshgrid(rx, tx, indexing="xy")
117
- src_tx = ops.mod(TX + n_rx // 4 - RX, n_tx) # (n_tx, n_rx // 2)
118
-
119
- # output[2t, r] = att[src_tx[t, r], 2r]; output[2t+1, r] = att[src_tx[t, r], 2r+1].
120
- # Gathering the even/odd columns separately along axis 0 with the same
121
- # src_tx index, then interleaving via stack+reshape, is equivalent to that
122
- # scatter but keras.ops.take_along_axis-only (no fancy 2D indexing needed).
123
- even = ops.take_along_axis(att[:, 0::2], src_tx, axis=0)
124
- odd = ops.take_along_axis(att[:, 1::2], src_tx, axis=0)
125
- sinogram = ops.reshape(ops.stack([even, odd], axis=1), (n_tx * 2, n_rx // 2))
126
- return {self.output_key: sinogram}
127
-
128
-
129
- @ops_registry("linearize_detectors")
130
- class LinearizeDetectors(Operation):
131
- """Resample each projection from the ring's arc positions onto a uniform
132
- linear (chord) axis, which is what parallel-beam FBP assumes.
133
-
134
- Detector `i` sits at angle `alpha_i` on the ring, so its perpendicular offset
135
- from the ring centre is `R * sin(alpha_i)` — compressed towards the edges of
136
- the aperture, not uniformly spaced. Backprojecting without correcting this
137
- distorts the image radially. Matches `linearize_detectors()` in us4us's
138
- `reconstruction_example.py` (added in their 2026-09-07 revision).
139
-
140
- `keras.ops` has no `interp`, but both the source (`xp`) and target (`x`) axes
141
- depend only on `n_detectors` and the radius, so the gather indices and
142
- interpolation weights are constant and precomputed here in numpy. Endpoint
143
- handling matches `np.interp` (clamp, no extrapolation).
144
- """
145
-
146
- # See the note on TransmissionAttenuation.__init__ for why this defaults to None.
147
- def __init__(self, probe_radius: float | None = None, **kwargs):
148
- super().__init__(**kwargs)
149
- self.probe_radius = PROBE_RADIUS if probe_radius is None else probe_radius
150
-
151
- def call(self, **kwargs):
152
- sinogram = kwargs[self.key] # (n_angles, n_detectors)
153
- n_col = sinogram.shape[1]
154
-
155
- i = np.arange(-(n_col // 2), n_col // 2)
156
- xp = self.probe_radius * np.sin(i * np.pi / 2 / n_col) # arc -> chord, non-uniform
157
- x = i * np.sqrt(2) * self.probe_radius / n_col # uniform target axis
158
-
159
- lo = np.clip(np.searchsorted(xp, x) - 1, 0, n_col - 2)
160
- w = np.clip((x - xp[lo]) / (xp[lo + 1] - xp[lo]), 0.0, 1.0).astype("float32")
161
-
162
- left = ops.take(sinogram, ops.convert_to_tensor(lo), axis=1)
163
- right = ops.take(sinogram, ops.convert_to_tensor(lo + 1), axis=1)
164
- return {self.output_key: left * (1.0 - w) + right * w}
165
-
166
-
167
- @ops_registry("filtered_backprojection")
168
- class FilteredBackprojection(Operation):
169
- """Ram-Lak (ramp) filter + backprojection onto a square grid sized to the
170
- detector count, vectorized over all angles in one gather-and-sum."""
171
-
172
- @staticmethod
173
- def _ramp_filter_half(n_detectors: int):
174
- """Ram-Lak filter, rfft-domain half. `sinogram` is real, so `rfft`/`irfft`
175
- (real in, real out) are used below instead of a full complex `fft`/`ifft`
176
- - there's no plain complex `ifft` in keras.ops anyway."""
177
- half = n_detectors // 2
178
- n = ops.concatenate([ops.arange(1.0, half + 1, 2.0), ops.arange(half - 1.0, 0.0, -2.0)])
179
- odd = -1.0 / (np.pi * n) ** 2
180
- even = ops.concatenate([ops.convert_to_tensor([0.25]), ops.zeros((half - 1,))])
181
- f = ops.reshape(ops.stack([even, odd], axis=1), (n_detectors,))
182
- real, _ = ops.rfft(f)
183
- return 2 * real
184
-
185
- def call(self, **kwargs):
186
- sinogram = kwargs[self.key] # (n_angles, n_detectors)
187
- n_angles, n_detectors = sinogram.shape
188
-
189
- ramp_half = self._ramp_filter_half(n_detectors)
190
- real, imag = ops.rfft(sinogram)
191
- filtered = ops.irfft((real * ramp_half, imag * ramp_half), fft_length=n_detectors)
192
-
193
- # Backprojection geometry (which detector index each pixel/angle maps to)
194
- # depends only on (n_angles, n_detectors).
195
- half = n_detectors // 2
196
- angles = ops.arange(n_angles, dtype="float32") * (2 * np.pi / n_angles)
197
- x = ops.arange(n_detectors) - half
198
- X, Y = ops.meshgrid(x, x) # (n_detectors, n_detectors)
199
- t = X[None] * ops.cos(angles)[:, None, None] + Y[None] * ops.sin(angles)[:, None, None]
200
- idx_raw = ops.cast(ops.round(t + half), "int32") # (n_angles, D, D)
201
- # Skip out-of-range detector indices per angle rather than clamping them
202
- # to the edge, which would smear a repeated edge value into the image.
203
- valid = ops.logical_and(idx_raw >= 0, idx_raw < n_detectors)
204
- idx_safe = ops.clip(idx_raw, 0, n_detectors - 1)
205
-
206
- gathered = ops.take_along_axis(
207
- ops.repeat(filtered[:, None, :], n_detectors, axis=1), idx_safe, axis=2
208
- ) # (n_angles, D, D)
209
- image = ops.sum(ops.where(valid, gathered, 0.0), axis=0)
210
- return {self.output_key: image}
211
-
212
-
213
- def build_pipeline(
214
- reference: float = 1.0,
215
- aperture_offset: int = APERTURE_OFFSET,
216
- probe_radius: float = PROBE_RADIUS,
217
- smooth_sigma: float = 1.0,
218
- ) -> Pipeline:
219
- """Every acquisition-specific constant is passed explicitly, so it round-trips
220
- into `pipeline.yaml` and the reconstruction is fully described by that file
221
- rather than by constants in this script."""
222
- return Pipeline(
223
- operations=[
224
- Cast(dtype="float32"),
225
- TransmissionAttenuation(reference=reference),
226
- ApertureRearrange(aperture_offset=aperture_offset),
227
- ResortSinogram(),
228
- LinearizeDetectors(probe_radius=probe_radius),
229
- FilteredBackprojection(),
230
- GaussianBlur(sigma=smooth_sigma, axes=(-2, -1)),
231
- ],
232
- with_batch_dim=False,
233
- )
234
-
235
-
236
- def write_config(pipeline: Pipeline, path: Path) -> None:
237
- config = pipeline.to_config()
238
- config.to_yaml(str(path))
239
-
240
-
241
- def parse_dead_channels(description: str) -> np.ndarray:
242
- """Dead-element indices, parsed from the file's root `description` text."""
243
- match = re.search(r"turned off[^:]*:\s*([\d,\s]+?)\s*\(numbering", description)
244
- if not match:
245
- return np.array([], dtype=np.int64)
246
- return np.array([int(x) for x in match.group(1).split(",") if x.strip()], dtype=np.int64)
247
-
248
-
249
- def ring_center_and_radius(probe_geometry: np.ndarray) -> tuple[np.ndarray, float]:
250
- """Ring center [x, z] and radius [m], measured (this ring is centered at
251
- z ~ 0.13 m, not the origin)."""
252
- xz = probe_geometry[:, [0, 2]]
253
- center = xz.mean(axis=0)
254
- radius = float(np.linalg.norm(xz - center, axis=-1).mean())
255
- return center, radius
256
-
257
-
258
- def rx_element_indices(aperture_offset: int, n_tx: int, n_rx: int) -> np.ndarray:
259
- """Physical ring-element index for every (transmit, raw receive channel)
260
- pair: `(n_tx, n_rx)`. Sizes come from the file, not from constants."""
261
- k = np.arange(n_rx)
262
- return (np.arange(n_tx)[:, None] + aperture_offset + k[None, :]) % n_tx
263
-
264
-
265
- def validate_geometry(rf, tx_position, rx_positions, sound_speed, initial_time, fs):
266
- """Predicted vs. measured direct-arrival sample, per receive channel, for one
267
- transmit. Agreement confirms the ring geometry, `initial_times`, and the
268
- aperture offset at once. `rf` is `(n_ax, n_rx)` real RF for one transmit."""
269
- distance = np.linalg.norm(rx_positions - tx_position, axis=-1)
270
- predicted = (distance / sound_speed - initial_time) * fs
271
- envelope = np.abs(rf)
272
- measured = envelope.argmax(axis=0)
273
- strong = envelope.max(axis=0) > 0.2 * envelope.max()
274
- residual = float(np.median(np.abs(measured[strong] - predicted[strong])))
275
- return predicted, measured, residual
276
-
277
-
278
- def main():
279
- parser = argparse.ArgumentParser(description=__doc__)
280
- parser.add_argument("--input", type=Path, required=True, help="a *.hdf5 file in this folder")
281
- parser.add_argument("--frame", type=int, default=0)
282
- parser.add_argument("--aperture_offset", type=int, default=APERTURE_OFFSET)
283
- parser.add_argument(
284
- "--probe_radius", type=float, default=PROBE_RADIUS, help="ring radius in metres"
285
- )
286
- parser.add_argument(
287
- "--smooth_sigma", type=float, default=1.0, help="post-FBP Gaussian smoothing"
288
- )
289
- args = parser.parse_args()
290
-
291
- input_path = args.input if args.input.exists() else HERE / args.input
292
- if not input_path.exists():
293
- raise FileNotFoundError(f"{args.input} not found (looked in cwd and {HERE}).")
294
- output_path = input_path.with_name(f"{input_path.stem}_reconstruct.png")
295
-
296
- # Build with every parameter explicit, save to pipeline.yaml, then reload and
297
- # run from that file - so the YAML alone fully describes the reconstruction.
298
- pipeline = build_pipeline(
299
- aperture_offset=args.aperture_offset,
300
- probe_radius=args.probe_radius,
301
- smooth_sigma=args.smooth_sigma,
302
- )
303
- write_config(pipeline, CONFIG)
304
- config = Config.from_path(str(CONFIG))
305
- pipeline = Pipeline.from_config(config)
306
-
307
- with File(str(input_path)) as f:
308
- probe_geometry = f.probe.probe_geometry[:]
309
- center, radius = ring_center_and_radius(probe_geometry)
310
- sound_speed = float(f.scan.sound_speed)
311
- fs = float(f.scan.sampling_frequency)
312
- initial_times = f.scan.initial_times[:]
313
- dead_elements = parse_dead_channels(str(f.attrs.get("description", "")))
314
- zea.log.info(f"Dead elements parsed from description: {dead_elements.tolist()}")
315
- # Cross-check the --probe_radius used by LinearizeDetectors against the
316
- # radius actually implied by probe_geometry.
317
- if abs(radius - args.probe_radius) > 1e-3:
318
- zea.log.warning(
319
- f"probe_radius={args.probe_radius:.4f} m differs from the measured ring "
320
- f"radius {radius:.4f} m (centre {center[0]:.4f}, {center[1]:.4f} m)"
321
- )
322
- else:
323
- zea.log.info(f"Ring radius: {radius:.4f} m (matches --probe_radius)")
324
-
325
- raw = np.asarray(f.data.raw_data[args.frame]) # (n_tx, n_ax, n_rx, n_ch)
326
-
327
- # As of the Sep-2026 resubmission these live in `data` as spatial maps
328
- # (with coordinates); older files put them in the free-form `custom`
329
- # group. Read `data` first, fall back to `custom` for the old layout.
330
- # us4us ship their own FBP output and sinogram alongside the raw data, as
331
- # spatial maps under `data` with `coordinates`.
332
- stored_image = np.asarray(f.data.image.values[args.frame])
333
- image_coords = np.asarray(f.data.image.coordinates)
334
- stored_sinogram = np.asarray(f.data.sinogram.values[args.frame])
335
- sinogram_coords = np.asarray(f.data.sinogram.coordinates)
336
-
337
- rx_idx = rx_element_indices(
338
- args.aperture_offset, n_tx=probe_geometry.shape[0], n_rx=raw.shape[2]
339
- ) # (n_tx, n_rx)
340
- ring_xz = probe_geometry[:, [0, 2]].astype(np.float32)
341
-
342
- predicted, measured, residual = validate_geometry(
343
- raw[0, :, :, 0].astype(np.float32),
344
- ring_xz[0],
345
- ring_xz[rx_idx[0]],
346
- sound_speed,
347
- float(initial_times[0]),
348
- fs,
349
- )
350
- zea.log.info(f"Direct-arrival check: median |measured - predicted| = {residual:.2f} samples")
351
-
352
- outputs = pipeline(data=raw, return_numpy=True)
353
- recon = outputs["data"] # (n_detectors, n_detectors)
354
-
355
- zea.visualize.set_mpl_style()
356
- fig, axes = plt.subplots(1, 4, figsize=(24, 5.5))
357
-
358
- n_rx = raw.shape[2]
359
- rf_db = 20 * np.log10(np.abs(raw[0, :, :, 0]) / (np.abs(raw[0, :, :, 0]).max() + 1e-12) + 1e-10)
360
- axes[0].imshow(rf_db, aspect="auto", cmap="gray", vmin=-60, vmax=0)
361
- axes[0].plot(np.arange(n_rx), predicted, "r--", lw=1.0, label="predicted direct arrival")
362
- axes[0].plot(np.arange(n_rx), measured, "c:", lw=0.7, alpha=0.6, label="measured (argmax)")
363
- axes[0].set_ylim(raw.shape[1], 0)
364
- axes[0].legend(loc="lower left", fontsize=7)
365
- axes[0].set_title(f"RF, transmit 0 [dB]\ngeometry check: residual {residual:.2f} samples")
366
- axes[0].set_xlabel("Receive channel")
367
- axes[0].set_ylabel("Axial sample")
368
-
369
- # After LinearizeDetectors the backprojection grid spans the uniform chord
370
- # axis, i.e. +-R*sqrt(2)/2 (~92 mm) about the ring centre - not +-R. Plotted
371
- # in mm relative to the ring centre, matching the frame of the stored maps'
372
- # own `coordinates` so the panels line up.
373
- half_width = args.probe_radius * np.sqrt(2) / 2 * 1e3
374
- extent = [-half_width, half_width, half_width, -half_width]
375
- vmin, vmax = np.percentile(recon, [1, 99])
376
- handle = axes[1].imshow(recon, cmap="magma", extent=extent, vmin=vmin, vmax=vmax)
377
- axes[1].set_title(f"Attenuation FBP (zea.Pipeline)\n({input_path.name}, frame {args.frame})")
378
- axes[1].set_xlabel("X (mm)")
379
- axes[1].set_ylabel("Z (mm)")
380
- cax = make_axes_locatable(axes[1]).append_axes("right", size="5%", pad=0.05)
381
- fig.colorbar(handle, cax=cax)
382
-
383
- # Stored sinogram: x is detector position in metres; the "z" slot carries the
384
- # projection angle in radians (0..2*pi) rather than a Cartesian coordinate.
385
- sino_extent = [
386
- sinogram_coords[..., 0].min() * 1e3,
387
- sinogram_coords[..., 0].max() * 1e3,
388
- sinogram_coords[..., 2].max(),
389
- sinogram_coords[..., 2].min(),
390
- ]
391
- axes[2].imshow(stored_sinogram, cmap="viridis", aspect="auto", extent=sino_extent)
392
- axes[2].set_title("Stored sinogram (us4us)")
393
- axes[2].set_xlabel("Detector position (mm)")
394
- axes[2].set_ylabel("Projection angle (rad)")
395
-
396
- img_extent = [
397
- image_coords[..., 0].min() * 1e3,
398
- image_coords[..., 0].max() * 1e3,
399
- image_coords[..., 2].max() * 1e3,
400
- image_coords[..., 2].min() * 1e3,
401
- ]
402
- svmin, svmax = np.percentile(stored_image, [1, 99])
403
- h = axes[3].imshow(
404
- stored_image, cmap="magma", extent=img_extent, vmin=svmin, vmax=svmax
405
- )
406
- axes[3].set_title("Stored FBP (us4us)")
407
- axes[3].set_xlabel("X (mm)")
408
- axes[3].set_ylabel("Z (mm)")
409
- cax = make_axes_locatable(axes[3]).append_axes("right", size="5%", pad=0.05)
410
- fig.colorbar(h, cax=cax)
411
-
412
- fig.suptitle(f"{input_path.name} — frame {args.frame}")
413
- fig.tight_layout()
414
- plt.savefig(str(output_path), bbox_inches="tight", dpi=100)
415
-
416
- print(f"Reconstructed : {recon.shape}")
417
- print(f"Saved : {output_path}")
418
-
419
-
420
- if __name__ == "__main__":
421
- main()