def write_example(filename):
# --- prepare data ---
# Generate fake data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
rawdata_white = np.ones(2 * 256 * 256, np.uint16).reshape(2, 256, 256)
rawdata_dark = np.zeros(10 * 256 * 256, np.uint16).reshape(10, 256, 256)
# x, y and z ranges
x = np.arange(256)
y = np.arange(256)
z = np.arange(180);
# --- create file ---
# Open DataExchangeFile file
f = DataExchangeFile(filename, mode='w')
# Create core HDF5 dataset in exchange group for 180 deep stack
# of x,y images /exchange/data
f.add_entry([
DataExchangeEntry.data(data={'value':rawdata, 'units':'counts'}),
DataExchangeEntry.data(data_dark={'value':rawdata_dark, 'units':'counts'}),
DataExchangeEntry.data(data_white={'value':rawdata_white, 'units':'counts'})
]
)
# --- All done ---
f.close()
def write_example(filename):
# --- prepare data ---
# Generate fake raw data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
# x, y and z ranges
x = np.arange(128)
y = np.arange(128)
z = np.arange(180);
# --- create file ---
# Open DataExchange file
f = DataExchangeFile(filename, mode='w')
# Create core HDF5 dataset in exchange group for 180 deep stack of x,y
# images /exchange/data
data_en = DataExchangeEntry.data(data={'value': rawdata, 'units':'counts', 'description': 'Projection Data',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
f.add_entry(data_en)
# The default location for sample in DataExchangeEntry is /measurement/sample
# To override the default set e.g 'root'='/measurement_4/sample'
sample_en = DataExchangeEntry.sample(name={'value': 'Minivirus'}, temperature={'value': 200.0, 'units':'celsius',
'dataset_opts': {'dtype': 'd'}})
f.add_entry(sample_en)
# --- All done ---
f.close()
def write_example(filename):
# --- prepare data ---
# Generate fake data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
rawdata_white = np.ones(2 * 256 * 256, np.uint16).reshape(2, 256, 256)
rawdata_dark = np.zeros(10 * 256 * 256, np.uint16).reshape(10, 256, 256)
# x, y and z ranges
x = np.arange(256)
y = np.arange(256)
z = np.arange(180)
# Fabricated theta values
theta = (z / float(180)) * 180.0
theta_white = (0.0, 180.0)
theta_dark = (0.0, 0.0, 0.0, 0.0, 0.0, 180.0, 180.0, 180.0, 180.0, 180.0)
# --- create file ---
# Open HDF5 file
f = DataExchangeFile(filename, mode='w')
#Create HDF5 dataset in exchange group for data, data_dark & data_white, theta, theta_dark, theta_white under /exchange
f.add_entry([
DataExchangeEntry.data(data={
'value': rawdata,
'units': 'counts',
'axes': 'theta:y:x'
}),
DataExchangeEntry.data(data_dark={
'value': rawdata_dark,
'units': 'counts',
'axes': 'theta:y:x'
}),
DataExchangeEntry.data(data_white={
'value': rawdata_white,
'units': 'counts',
'axes': 'theta:y:x'
}),
DataExchangeEntry.data(theta={
'value': theta,
'units': 'degrees'
}),
DataExchangeEntry.data(theta_dark={
'value': theta_dark,
'units': 'degrees'
}),
DataExchangeEntry.data(theta_white={
'value': theta_white,
'units': 'degrees'
})
])
# --- All done ---
f.close()
def write_example(filename):
# --- prepare data ---
# Generate fake raw data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
# x, y and z ranges
x = np.arange(128)
y = np.arange(128)
z = np.arange(180);
# --- create file ---
# Open HDF5 file
f = DataExchangeFile(filename, mode='w')
# Create core HDF5 dataset in exchange group for 180 deep stack of x,y
# images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': rawdata, 'units':'counts', 'description': 'Projection Data',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
# Create HDF5 subgroup
# /measurement/sample
f.add_entry( DataExchangeEntry.sample(name={'value': 'Minivirus'}, temperature={'value': 200.0, 'units':'celsius',
'dataset_opts': {'dtype': 'd'}})
)
# Create HDF5 subgroup
# /measurement/instrument
f.add_entry( DataExchangeEntry.instrument(name={'value': 'APS 2-BM'}) )
# Create HDF5 subgroup
# /measurement/instrument/monochromator
f.add_entry( DataExchangeEntry.monochromator(name={'value': 'DMM'},
energy={'value': 10.00, 'units':'keV', 'dataset_opts': {'dtype':'d'}}))
# --- All done ---
f.close()
def write_example(filename):
# --- prepare data ---
# Generate fake data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
# x, y and z ranges
x = np.arange(256)
y = np.arange(256)
z = np.arange(180);
# --- create file ---
# Open DataExchange file
f = DataExchangeFile(filename, mode='w')
# Create a DataExchangeEntry and dd the entry to the data exchange file.
f.add_entry(DataExchangeEntry.data(data={'value':rawdata, 'units':'counts'}))
# --- All done ---
f.close()
def write_example(filename):
# --- prepare data ---
# Generate fake data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
rawdata_white = np.ones(2 * 256 * 256, np.uint16).reshape(2, 256, 256)
rawdata_dark = np.zeros(10 * 256 * 256, np.uint16).reshape(10, 256, 256)
# x, y and z ranges
x = np.arange(256)
y = np.arange(256)
z = np.arange(180);
# Fabricated theta values
theta = (z / float(180)) * 180.0
theta_white = (0.0, 180.0)
theta_dark = (0.0, 0.0, 0.0, 0.0, 0.0, 180.0, 180.0, 180.0, 180.0, 180.0)
# --- create file ---
# Open HDF5 file
f = DataExchangeFile(filename, mode='w')
#Create HDF5 dataset in exchange group for data, data_dark & data_white, theta, theta_dark, theta_white under /exchange
f.add_entry([
DataExchangeEntry.data(data={'value':rawdata, 'units':'counts', 'axes': 'theta:y:x'}),
DataExchangeEntry.data(data_dark={'value':rawdata_dark, 'units':'counts', 'axes': 'theta:y:x'}),
DataExchangeEntry.data(data_white={'value':rawdata_white, 'units':'counts', 'axes': 'theta:y:x'}),
DataExchangeEntry.data(theta={'value':theta, 'units':'degrees'}),
DataExchangeEntry.data(theta_dark={'value':theta_dark, 'units':'degrees'}),
DataExchangeEntry.data(theta_white={'value':theta_white, 'units':'degrees'})
])
# --- All done ---
f.close()
def main():
file_name = '/local/data/databank/TXM_26ID/20130731_004_Stripe_Solder_Sample_Tip1_TomoScript_181imgs_p1s_b1.txrm'
white_file_name = '/local/data/databank/TXM_26ID/20130731_001_Background_Reference_20imgs_p5s_b1.xrm'
hdf5_file_name = '/local/data/databank/dataExchange/TXM/20130731_004_Stripe_Solder_Sample_Tip1_nx.h5'
log_file = '/local/data/databank/dataExchange/TXM/20130731_004_Stripe_Solder_Sample_Tip1.log'
mydata = Convert()
# Create minimal hdf5 file
if verbose: print "Reading data ... "
mydata.stack(file_name,
hdf5_file_name=hdf5_file_name,
white_file_name=white_file_name,
sample_name='Stripe_Solder_Sample_Tip1')
# Add extra metadata if available / desired
reader = xradia.xrm()
array = dstruct
reader.read_txrm(file_name, array)
# Read angles
n_angles = np.shape(array.exchange.angles)
if verbose: print "Done reading ", n_angles, " angles"
theta = np.zeros(n_angles)
theta = array.exchange.angles[:]
# Save any other available metadata in a log file
f = open(log_file, 'w')
f.write('Data creation date: \n')
f.write(str(array.information.file_creation_datetime))
f.write('\n')
f.write('=======================================\n')
f.write('Sample name: \n')
f.write(str(array.information.sample.name))
f.write('\n')
f.write('=======================================\n')
f.write('Experimenter name: \n')
f.write(str(array.information.experimenter.name))
f.write('\n')
f.write('=======================================\n')
f.write('X-ray energy: \n')
f.write(str(array.exchange.energy))
f.write(str(array.exchange.energy_units))
f.write('\n')
f.write('=======================================\n')
f.write('Angles: \n')
f.write(str(array.exchange.angles))
f.write('\n')
f.write('=======================================\n')
f.write('Data axes: \n')
f.write(str(array.exchange.data_axes))
f.write('\n')
f.write('=======================================\n')
f.write('x distance: \n')
f.write(str(array.exchange.x))
f.write('\n')
f.write('=======================================\n')
f.write('x units: \n')
f.write(str(array.exchange.x_units))
f.write('\n')
f.write('=======================================\n')
f.write('y distance: \n')
f.write(str(array.exchange.y))
f.write('\n')
f.write('=======================================\n')
f.write('y units: \n')
f.write(str(array.exchange.y_units))
f.write('\n')
f.close()
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='a')
# Create HDF5 subgroup
# /measurement/instrument
f.add_entry(DataExchangeEntry.instrument(name={'value': 'APS-CNM 26-ID'}))
### Create HDF5 subgroup
### /measurement/instrument/source
f.add_entry(
DataExchangeEntry.source(
name={'value': "Advanced Photon Source"},
date_time={'value': "2013-07-31T19:42:13+0100"},
beamline={'value': "26-ID"},
))
# Create HDF5 subgroup
# /measurement/instrument/monochromator
f.add_entry(
DataExchangeEntry.monochromator(
type={'value': 'Unknown'},
energy={
'value': float(array.exchange.energy[0]),
'units': 'keV',
'dataset_opts': {
'dtype': 'd'
}
},
mono_stripe={'value': 'Unknown'},
))
# Create HDF5 subgroup
# /measurement/experimenter
f.add_entry(
DataExchangeEntry.experimenter(
name={'value': "Robert Winarski"},
role={'value': "Project PI"},
))
# Create HDF5 subgroup
# /measurement/sample
f.add_entry(
DataExchangeEntry.data(theta={
'value': theta,
'units': 'degrees'
}))
f.close()
print "Done creating data exchange file: ", hdf5_file_name
def write_example(filename):
# --- prepare data ---
# Generate fake raw data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
rawdata_white = np.ones(2 * 256 * 256, np.uint16).reshape(2, 256, 256)
rawdata_dark = np.zeros(10 * 256 * 256, np.uint16).reshape(10, 256, 256)
# Generate fake normalized data
normalizeddata = np.ones(180 * 256 * 256, \
np.float64).reshape(180, 256, 256)
# Generate fake reconstructed data
reconstructeddata = np.ones(256 * 256 * 256, \
np.float64).reshape(256, 256, 256)
# x, y and z ranges
x = np.arange(128)
y = np.arange(128)
z = np.arange(180);
# Fabricated theta values
theta = (z / float(180)) * 180.0
theta_white = (0.0, 180.0)
theta_dark = (0.0, 0.0, 0.0, 0.0, 0.0, 180.0, 180.0, 180.0, 180.0, 180.0)
# Fabricated data_shift_x and data_shift_y value
data_shift_x = np.random.randint(-100, 100, size=180)
data_shift_y = np.random.randint(-100, 100, size=180)
# --- create file ---
print filename
# Open DataExchange file
f = DataExchangeFile(filename, mode='w')
# Create core HDF5 dataset in exchange group for 180 deep stack
# of x,y images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': rawdata, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
f.add_entry( DataExchangeEntry.data(title={'value': 'tomography_raw_projections'}))
f.add_entry( DataExchangeEntry.data(data_dark={'value':rawdata_dark, 'units':'counts', 'axes':'theta_dark:y:x',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
f.add_entry( DataExchangeEntry.data(data_white={'value': rawdata_white, 'units':'counts', 'axes':'theta_white:y:x',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
f.add_entry( DataExchangeEntry.data(theta={'value': theta, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(theta_dark={'value': theta_dark, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(theta_white={'value': theta_white, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(data_shift_x={'value': data_shift_x}))
f.add_entry( DataExchangeEntry.data(data_shift_y={'value': data_shift_y}))
# Exchange HDF5 group
# /exchange_2
# this will be the out_put of the normalization process
f.add_entry( DataExchangeEntry.data(root='exchange_2', title={'value': 'tomography normalized projections'}) )
f.add_entry( DataExchangeEntry.data(root='exchange_2', data={'value': normalizeddata, 'units':'counts', 'axes':'theta:y:x',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
f.add_entry( DataExchangeEntry.data(root='exchange_2', theta={'value': theta, 'units':'degrees'}))
# Exchange HDF5 group
# /exchange_3
# this will be the out_put of the reconstruction process
f.add_entry( DataExchangeEntry.data(root='exchange_3', title={'value': 'tomography reconstructions'}) )
f.add_entry( DataExchangeEntry.data(root='exchange_3', data={'value': reconstructeddata, 'units':'density', 'axes':'z:y:x',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} })
)
# Create HDF5 group measurement
# /measuremen
f.add_entry( DataExchangeEntry.instrument(name={'value': 'APS 2-BM'}) )
# Create HDF5 subgroup
# /measurement/instrument/source
f.add_entry( DataExchangeEntry.source(name={'value': 'APS'},
date_time={'value': "2012-07-31T21:15:23+0600"},
beamline={'value': "2-BM"},
current={'value': 101.199, 'units': 'mA', 'dataset_opts': {'dtype': 'd'}},
energy={'value': 7.0, 'units':'GeV', 'dataset_opts': {'dtype': 'd'}},
mode={'value':'TOPUP'}
)
)
# Create HDF5 subgroup
# /measurement/instrument/attenuator
f.add_entry( DataExchangeEntry.attenuator(thickness={'value': 1e-3, 'units': 'm', 'dataset_opts': {'dtype': 'd'}},
type={'value': 'Al'}
)
)
# Create HDF5 subgroup
# /measurement/instrument/monochromator
f.add_entry( DataExchangeEntry.monochromator(type={'value': 'Multilayer'},
energy={'value': 19.26, 'units': 'keV', 'dataset_opts': {'dtype': 'd'}},
energy_error={'value': 1e-3, 'units': 'keV', 'dataset_opts': {'dtype': 'd'}},
mono_stripe={'value': 'Ru/C'},
)
)
# Create HDF5 subgroup
# /measurement/instrument/detector
f.add_entry( DataExchangeEntry.detector(manufacturer={'value':'CooKe Corporation'},
model={'value': 'pco dimax'},
serial_number={'value': '1234XW2'},
bit_depth={'value': 12, 'dataset_opts': {'dtype': 'd'}},
x_pixel_size={'value': 6.7e-6, 'dataset_opts': {'dtype': 'f'}},
y_pixel_size={'value': 6.7e-6, 'dataset_opts': {'dtype': 'f'}},
x_dimensions={'value': 2048, 'dataset_opts': {'dtype': 'i'}},
y_dimensions={'value': 2048, 'dataset_opts': {'dtype': 'i'}},
x_binning={'value': 1, 'dataset_opts': {'dtype': 'i'}},
y_binning={'value': 1, 'dataset_opts': {'dtype': 'i'}},
operating_temperature={'value': 270, 'units':'K', 'dataset_opts': {'dtype': 'f'}},
exposure_time={'value': 170, 'units':'ms', 'dataset_opts': {'dtype': 'd'}},
frame_rate={'value': 3, 'dataset_opts': {'dtype': 'i'}},
output_data={'value':'/exchange'}
)
)
f.add_entry( DataExchangeEntry.roi(name={'value':'Center Third'},
x1={'value':256, 'dataset_opts': {'dtype': 'i'}},
x2={'value':1792, 'dataset_opts': {'dtype': 'i'}},
y1={'value':256, 'dataset_opts': {'dtype': 'i'}},
y2={'value':1792, 'dataset_opts': {'dtype': 'i'}},
)
)
f.add_entry(DataExchangeEntry.objective(manufacturer={'value':'Zeiss'},
model={'value':'Plan-NEOFLUAR 1004-072'},
magnification={'value':20, 'dataset_opts': {'dtype': 'd'}},
numerical_aperture={'value':0.5, 'dataset_opts': {'dtype': 'd'}},
)
)
f.add_entry(DataExchangeEntry.scintillator(manufacturer={'value':'Crytur'},
serial_number={'value':'12'},
name={'value':'YAG polished'},
type={'value':'YAG on YAG'},
scintillating_thickness={'value':5e-6, 'dataset_opts': {'dtype': 'd'}},
substrate_thickness={'value':1e-4, 'dataset_opts': {'dtype': 'd'}},
)
)
# Create HDF5 subgroup
# /measurement/sample
f.add_entry( DataExchangeEntry.sample( name={'value':'Hornby_b'},
description={'value':'test sample'},
preparation_date={'value':'2011-07-31T21:15:23+0600'},
chemical_formula={'value':'unknown'},
mass={'value':0.25, 'units':'g', 'dataset_opts': {'dtype': 'd'}},
enviroment={'value':'air'},
temperature={'value':120.0, 'units':'Celsius', 'dataset_opts': {'dtype': 'd'}},
temperature_set={'value':130.0, 'units':'Celsius', 'dataset_opts': {'dtype': 'd'}},
)
)
# Create HDF5 subgroup
# /measurement/sample/geometry/translation
f.add_entry( DataExchangeEntry.translation(root='/measurement/sample/geometry',
distances={'value':[0,0,0],'axes':'z:y:x', 'units':'m', 'dataset_opts': {'dtype': 'd'}}
)
)
# Create HDF5 subgroup
# /measurement/experimenter
f.add_entry( DataExchangeEntry.experimenter(name={'value':"John Doe"},
role={'value':"Project PI"},
affiliation={'value':"University of California, Berkeley"},
address={'value':"EPS UC Berkeley CA 94720 4767 USA"},
phone={'value':"+1 123 456 0000"},
email={'value':"*****@*****.**"},
facility_user_id={'value':"a123456"},
)
)
# Create HDF5 subgroup
# /measurement/experiment
f.add_entry( DataExchangeEntry.experiment( proposal={'value':"1234"},
activity={'value':"e11218"},
safety={'value':"9876"},
)
)
# --- All done ---
f.close()
def xtomo_exchange(self,
data,
data_white=None,
data_dark=None,
theta=None,
sample_name=None,
data_exchange_type=None,
hdf5_file_name=None,
log='INFO'):
"""
Write 3-D data to a data-exchange file.
Parameters
----------
data : ndarray
3-D X-ray absorption tomography raw data.
Size of the dimensions should be:
[projections, slices, pixels].
data_white, data_dark : ndarray, optional
3-D white-field/dark_field data. Multiple
projections are stacked together to obtain
a 3-D matrix. 2nd and 3rd dimensions should
be the same as data: [shots, slices, pixels].
theta : ndarray, optional
Data acquisition angles corresponding
to each projection.
data_excahnge_type : str
label defyining the type of data contained in data exchange file
for raw data tomography data use 'tomography_raw_projections'
hd5_file_name : str
Output file.
Notes
-----
If file exists, does nothing
Examples
--------
- Convert tomographic projection series (raw, dark, white) of tiff in data exchange:
>>> from dataexchange import xtomo_importer as dx
>>> from dataexchange import xtomo_exporter as ex
>>> file_name = '/local/dataraid/databank/Anka/radios/image_.tif'
>>> dark_file_name = '/local/dataraid/databank/Anka/darks/image_.tif'
>>> white_file_name = '/local/dataraid/databank/Anka/flats/image_.tif'
>>> hdf5_file_name = '/local/dataraid/databank/dataExchange/tmp/Anka.h5'
>>> projections_start = 0
>>> projections_end = 3167
>>> white_start = 0
>>> white_end = 100
>>> dark_start = 0
>>> dark_end = 100
>>> sample_name = 'Anka'
>>>
>>> mydata = dx.Import()
>>> # Read series of images
>>> data, white, dark, theta = mydata.xtomo_raw(file_name,
>>> projections_start = projections_start,
>>> projections_end = projections_end,
>>> white_file_name = white_file_name,
>>> white_start = white_start,
>>> white_end = white_end,
>>> dark_file_name = dark_file_name,
>>> dark_start = dark_start,
>>> dark_end = dark_end,
>>> projections_digits = 5,
>>> log='INFO'
>>> )
>>> mydata = ex.Export()
>>> # Create minimal data exchange hdf5 file
>>> mydata.xtomo_exchange(data = data,
>>> data_white = white,
>>> data_dark = dark,
>>> theta = theta,
>>> hdf5_file_name = hdf5_file_name,
>>> data_exchange_type = 'tomography_raw_projections',
>>> sample_name = sample_name
>>> )
"""
if (hdf5_file_name != None):
if os.path.isfile(hdf5_file_name):
self.logger.error("Data Exchange file: [%s] already exists",
hdf5_file_name)
else:
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
# Write the Data Exchange HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
self.logger.info("Creating Data Exchange File [%s]",
hdf5_file_name)
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
self.logger.info(
"Adding projections to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data={
'value': data,
'units': 'counts',
'description': 'transmission',
'axes': 'theta:y:x'
}))
# f.add_entry( DataExchangeEntry.data(data={'value': data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if (theta != None):
f.add_entry(
DataExchangeEntry.data(theta={
'value': theta,
'units': 'degrees'
}))
self.logger.info("Adding theta to Data Exchange File [%s]",
hdf5_file_name)
else:
self.logger.warning("theta is not defined")
if (data_dark != None):
self.logger.info(
"Adding dark fields to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_dark={
'value': data_dark,
'units': 'counts',
'axes': 'theta_dark:y:x'
}))
# f.add_entry( DataExchangeEntry.data(data_dark={'value': data_dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data dark is not defined")
if (data_white != None):
self.logger.info(
"Adding white fields to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_white={
'value': data_white,
'units': 'counts',
'axes': 'theta_white:y:x'
}))
# f.add_entry( DataExchangeEntry.data(data_white={'value': data_white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data white is not defined")
if (data_exchange_type != None):
self.logger.info(
"Adding data type to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
title={'value': data_exchange_type}))
if (sample_name == None):
sample_name = end[0]
f.add_entry(
DataExchangeEntry.sample(
name={'value': sample_name},
description={
'value':
'Sample name was assigned by the HDF5 converter and based on the HDF5 file name'
}))
else:
f.add_entry(
DataExchangeEntry.sample(
name={'value': sample_name},
description={
'value':
'Sample name was read from the user log file'
}))
f.close()
self.logger.info("DONE!!!!. Created Data Exchange File [%s]",
hdf5_file_name)
else:
self.logger.warning("Nothing to do ...")
def pack_data_exchange():
f = DataExchangeFile(CXP.io.data_exchange_filename, mode='w')
sim = DataExchangeEntry.simulation(
name={'value': 'Simulated Ptycho Data.'},
energy={'value': CXP.experiment.energy, 'units':'keV'},
focusing_optic={'value': CXP.experiment.optic},
probe_modes={'value':CXP.reconstruction.probe_modes},
noise_model={'value': CXP.simulation.noise_model},
gaussian_noise_level={'value': CXP.simulation.gaussian_noise_level},
total_photons={'value': CXP.simulation.total_photons},
beam_stop={'value': CXP.simulation.beam_stop},
beam_stop_size={'value':CXP.simulation.beam_stop_size},
beam_stop_attenuation={'value':CXP.simulation.beam_stop_attenuation},
defocus = {'value':CXP.simulation.defocus},
position_jitter={'value': CXP.reconstruction.initial_position_jitter_radius, 'units':'pixels'}
)
f.add_entry(sim)
sample = DataExchangeEntry.sample(
root='/simulation',
name={'value':'ground truth sample complex amplitude'},
data={'value': cxph.sample.data[0], 'units':'sqrt(counts)'},
)
f.add_entry(sample)
probe = DataExchangeEntry.sample(
root='/simulation',
entry_name='probe',
)
for mode in range(CXP.reconstruction.probe_modes):
setattr(probe, 'mode_{:d}'.format(mode), {'value': cxph.input_probe.modes[mode].data[0], 'units':'counts'})
f.add_entry(probe)
detector = DataExchangeEntry.detector(
root='/simulation',
x_pixel_size={'value': CXP.experiment.dx_d},
y_pixel_size={'value': CXP.experiment.dx_d},
x_dimension={'value': CXP.experiment.px},
y_dimension={'value': CXP.experiment.py},
distance={'value': CXP.experiment.z},
basis_vectors={'value': [[0,-CXP.experiment.dx_d,0],[-CXP.experiment.dx_d,0,0]]},
corner_position={'value': [0,0,0]}
)
f.add_entry(detector)
data = DataExchangeEntry.data(
name={'value': 'simulated_data'},
data={'value': sp.array(cxph.det_mod.data), 'axes':'translation:y:x', 'units':'counts',
'dataset_opts': {'compression': 'gzip', 'compression_opts': 4}},
translation={'value':'/exchange/sample/geometry/translation'}
)
f.add_entry(data)
# Get scan positions into dex format
pos = sp.zeros((cxph.positions.total, 3))
y, x = cxph.positions.correct
for i in range(cxph.positions.total):
pos[i,0], pos[i, 1] = x[i]*CXP.dx_s, y[i]*CXP.dx_s
positions = DataExchangeEntry.translation(
root='/exchange/sample/geometry',
name={'value':'ptychography scan positions'},
scan_type={'value': CXP.measurement.ptycho_scan_type},
data={'value': pos, 'units': 'm'}
)
f.add_entry(positions)
f.close()
def nexus(self, file_name,
hdf5_file_name,
projections_start=None,
projections_end=None,
projections_step=None,
slices_start=None,
slices_end=None,
slices_step=None,
pixels_start=None,
pixels_end=None,
pixels_step=None,
white_start=None,
white_end=None,
dark_start=None,
dark_end=None,
array_name='entry/instrument/detector/data',
sample_name=None,
dtype='float32'):
""" Read Data Exchange HDF5 file.
Parameters
----------
file_name : str
Input file.
projections_start, projections_end, projections_step : scalar, optional
Values of the start, end and step of the projections to
be used for slicing for the whole ndarray.
slices_start, slices_end, slices_step : scalar, optional
Values of the start, end and step of the slices to
be used for slicing for the whole ndarray.
pixels_start, pixels_end, pixels_step : scalar, optional
Values of the start, end and step of the pixels to
be used for slicing for the whole ndarray.
white_start, white_end : scalar, optional
Values of the start, end and step of the
slicing for the whole white field shots.
dark_start, dark_end : scalar, optional
Values of the start, end and step of the
slicing for the whole dark field shots.
dtype : str, optional
Desired output data type.
"""
print "Reading NeXus file ..."
self.file_name = file_name
# Initialize f to null.
f = None
# Get the file_name in lower case.
lFn = file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
# If the string has an extension.
if len(end) > 1:
# Check.
if end[len(end) - 1] == 'h5' or end[len(end) - 1] == 'hdf':
f = Hdf5()
# If f != None the call read on it.
if not f == None:
# Read data from exchange group.
self.data = f.read(file_name,
array_name=array_name,
x_start=projections_start,
x_end=projections_end,
x_step=projections_step,
y_start=slices_start,
y_end=slices_end,
y_step=slices_step,
z_start=pixels_start,
z_end=pixels_end,
z_step=pixels_step).astype(dtype)
# Read white field data from exchange group.
print white_start, white_end, slices_start, slices_end
self.white = f.read(file_name,
array_name=array_name,
x_start=white_start,
x_end=white_end,
y_start=slices_start,
y_end=slices_end,
y_step=slices_step,
z_start=pixels_start,
z_end=pixels_end,
z_step=pixels_step).astype(dtype)
# Read dark field data from exchange group.
self.dark = f.read(file_name,
array_name=array_name,
x_start=dark_start,
x_end=dark_end,
y_start=slices_start,
y_end=slices_end,
y_step=slices_step,
z_start=pixels_start,
z_end=pixels_end,
z_step=pixels_step).astype(dtype)
# Assign the rotation center.
self.center = self.data.shape[2] / 2
# Write HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
logger.info("Writing the HDF5 file")
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': self.data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(theta={'value': self.theta, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(data_dark={'value': self.dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(data_white={'value': self.white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(title={'value': 'tomography_raw_projections'}))
logger.info("Sample name = %s", sample_name)
if (sample_name == None):
sample_name = end[0]
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was assigned by the HDF5 converter and based on the HDF5 fine name'}))
logger.info("Assigned default file name: %s", end[0])
else:
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was read from the user log file'}))
logger.info("Assigned file name from user log")
f.close()
else:
print 'Unsupported file.'
def stack(self, file_name,
hdf5_file_name,
projections_data_type='txrm',
white_file_name='',
white_data_type='xrm',
dark_file_name='',
dark_data_type='xrm',
sample_name=None,
verbose=True):
"""Read a stack of tomographic data consisting of up to 3 files.
Supported formats:
X-radia data:
txrm: one mandatory file, containing the projections
xrm: two optional files contating white and dark images
ESRF ID-19 data:
edf: one mandatory file, containing the projections
edf: two optional files contating white and dark images
Parameters
----------
file_name : str
Name of the txrm/edf file containing the projections.
hdf5_file_name : str
HDF5/data exchange file name
white_file_name, dark_file_name : str, optional
Name of the xrm/edf fileS containing the white and dark images
projection_data_type, white_data_type, dark_data_type : str, optional
Returns
-------
inputData : list of hdf files contating projections, white and dark images
Output : saves the data as HDF5 in hdf5_file_name
.. See also:: http://docs.scipy.org/doc/numpy/user/basics.types.html
"""
# Initialize f to null.
hdf5_file_extension = False
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
logger.info(end)
# If the string has an extension.
if len(end) > 1:
# Check.
if end[len(end) - 1] == 'h5' or end[len(end) - 1] == 'hdf':
hdf5_file_extension = True
logger.info("HDF file extension is .h5 or .hdf")
else:
hdf5_file_extension = False
logger.info("HDF file extension must be .h5 or .hdf")
# If the extension is correct and the file does not exists then convert
if (hdf5_file_extension and (os.path.isfile(hdf5_file_name) == False)):
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
logger.info("File Name Projections = %s", file_name)
logger.info("File Name White = %s", white_file_name)
logger.info("File Name Dark = %s", dark_file_name)
if os.path.isfile(file_name):
logger.info("Reading projections file: %s", os.path.realpath(file_name))
logger.info("data type: %s", projections_data_type)
if (projections_data_type is 'txrm'):
f = Txrm()
tmpdata = f.read(file_name)
self.data = tmpdata
if (projections_data_type is 'edf'):
f = Esrf()
tmpdata = f.read(file_name)
self.data = tmpdata
if os.path.isfile(white_file_name):
logger.info("Reading white file: %s", os.path.realpath(white_file_name))
logger.info("data type: %s", white_data_type)
if (white_data_type is 'xrm'):
f = Xrm()
tmpdata = f.read(white_file_name)
#inputData[m, :, :] = tmpdata
self.white = tmpdata
if (white_data_type is 'edf'):
f = Esrf()
tmpdata = f.read(white_file_name)
#inputData[m, :, :] = tmpdata
self.white = tmpdata
else:
nx, ny, nz = np.shape(self.data)
self.dark = np.ones((nx,ny,1))
if os.path.isfile(dark_file_name):
logger.info("Reading dark file: %s", os.path.realpath(dark_file_name))
logger.info("data type: %s", dark_data_type)
if (white_data_type is 'xrm'):
f = Xrm()
tmpdata = f.read(dark_file_name)
#inputData[m, :, :] = tmpdata
self.dark = tmpdata
if (white_data_type is 'edf'):
f = Esrf()
tmpdata = f.read(dark_file_name)
#inputData[m, :, :] = tmpdata
self.dark = tmpdata
else:
nx, ny, nz = np.shape(self.data)
self.dark = np.zeros((nx,ny,1))
# Write HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
logger.info("Writing the HDF5 file")
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': self.data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(theta={'value': self.theta, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(data_dark={'value': self.dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(data_white={'value': self.white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(title={'value': 'tomography_raw_projections'}))
logger.info("Sample name = %s", sample_name)
if (sample_name == None):
sample_name = end[0]
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was assigned by the HDF5 converter and based on the HDF5 fine name'}))
logger.info("Assigned default file name: %s", end[0])
else:
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was read from the user log file'}))
logger.info("Assigned file name from user log")
f.close()
else:
if os.path.isfile(hdf5_file_name):
print 'HDF5 already exists. Nothing to do ...'
if (hdf5_file_extension == False):
print "HDF file extension must be .h5 or .hdf"
def create_theta_stack(filenames, output_filename):
shutil.copy(filenames[0], output_filename)
f_tomo = DataExchangeFile(output_filename, mode='a')
# Stackable datasets
# I will create a theta stack for every dataset which has a root entry called 'exchange' and 'exchange_N'
with DataExchangeFile(filenames[0], mode='r') as f_dex:
stackable_datasets = [dataset for dataset in f_dex.keys() if dataset.find('exchange_')>-1]
print 'Found {:d} stackable datasets: '.format(len(stackable_datasets)), stackable_datasets
for dataset in stackable_datasets:
print 'Adding {:s}'.format(dataset)
# loop through all files to determine the image sizes that will be stacked.
angles = {}
shapes = []
for filename in filenames:
f_dex = DataExchangeFile(filename, mode='r')
angles[f_dex['/exchange_0/angle'].value] = (filename, f_dex['/'.join([dataset, 'data'])].shape)
shapes.append(f_dex['/'.join([dataset, 'data'])].shape)
f_dex.close()
shapes = list(set(shapes))
print 'Found {:d} different array shapes: '.format(len(shapes)), shapes[0]
# Find the max array size
if len(shapes)>1:
xmin, ymin = 0,0
for dim in shapes[0]:
if dim[1]>xmin:
xmin=dim[1]
if dim[2]>ymin:
ymin=dim[2]
else:
channels, xmin, ymin = shapes[0]
array_shape = [len(filenames), channels, xmin, ymin]
# Need to add the DataExchange entry in non-standard way because arrays are so large they can't
# be held in memory simultaneously. So I create a dataset with a single array and the resize
# it to the right shape. Then arrays can be added individually.
try:
del f_tomo[dataset+'/data']
except KeyError:
pass
if dataset == 'exchange_0':
try:
del f_tomo[dataset+'/angle']
except KeyError:
pass
for i_theta, angle in enumerate(sorted(angles.keys(), key=float)):
print 'Adding angle {:s}'.format(angle)
with DataExchangeFile(angles[angle][0], mode='r') as f_dex:
if i_theta==0:
ashape = list(f_dex[dataset+'/data'].shape)
ashape.insert(0,1)
entry = DataExchangeEntry.data(
root='/'+dataset,
data={
'value': sp.zeros(ashape),
'units': f_dex['/'.join([dataset, 'data'])].attrs['units'],
'description': f_dex['/'.join([dataset, 'data'])].attrs['description'],
'axes': 'angle:'+f_dex['/'.join([dataset, 'data'])].attrs['axes'],
'dataset_opts': {
'compression': 'gzip',
'compression_opts': 4,
'maxshape': (None, None, None, None)
}
},
angles={
'value': sorted(angles.keys(), key=float),
'units': 'degrees',
'description': 'Angles at which each projection was acquired.'
}
)
f_tomo.add_entry(entry)
f_tomo['/'.join([dataset, 'data'])].resize(tuple(array_shape))
f_tomo['/'.join([dataset, 'data'])][i_theta,:,:,:] = f_dex[dataset+'/data'].value
f_tomo.close()
def xtomo_exchange(xtomo, data, data_white=None, data_dark=None, theta=None, sample_name=None,
data_exchange_type=None,
hdf5_file_name=None,
log='INFO'
):
"""
Write 3-D data to a data-exchange file.
Parameters
----------
data : ndarray
3-D X-ray absorption tomography raw data.
Size of the dimensions should be:
[projections, slices, pixels].
data_white, data_dark : ndarray, optional
3-D white-field/dark_field data. Multiple
projections are stacked together to obtain
a 3-D matrix. 2nd and 3rd dimensions should
be the same as data: [shots, slices, pixels].
theta : ndarray, optional
Data acquisition angles corresponding
to each projection.
data_excahnge_type : str
label defyining the type of data contained in data exchange file
for raw data tomography data use 'tomography_raw_projections'
hd5_file_name : str
Output file.
Notes
-----
If file exists, does nothing
Examples
--------
- Convert tomographic projection series (raw, dark, white) of tiff in data exchange:
>>> from dataexchange import xtomo_importer as dx
>>> from dataexchange import xtomo_exporter as ex
>>> file_name = '/local/dataraid/databank/Anka/radios/image_.tif'
>>> dark_file_name = '/local/dataraid/databank/Anka/darks/image_.tif'
>>> white_file_name = '/local/dataraid/databank/Anka/flats/image_.tif'
>>>
>>> hdf5_file_name = '/local/dataraid/databank/dataExchange/microCT/xx_yy_Anka.h5'
>>>
>>> projections_start = 0
>>> projections_end = 3167
>>> white_start = 0
>>> white_end = 100
>>> dark_start = 0
>>> dark_end = 100
>>>
>>> sample_name = 'Anka'
>>>
>>> mydata = dx.Import()
>>> # Read series of images
>>> data, white, dark, theta = mydata.series_of_images(file_name,
>>> projections_start = projections_start,
>>> projections_end = projections_end,
>>> white_file_name = white_file_name,
>>> white_start = white_start,
>>> white_end = white_end,
>>> dark_file_name = dark_file_name,
>>> dark_start = dark_start,
>>> dark_end = dark_end,
>>> sample_name = sample_name,
>>> projections_digits = 5,
>>> log='INFO'
>>> )
>>>
>>> mydata = ex.Export()
>>> # Create minimal data exchange hdf5 file
>>> mydata.xtomo_exchange(data = data,
>>> data_white = white,
>>> data_dark = dark,
>>> theta = theta,
>>> hdf5_file_name = hdf5_file_name,
>>> data_exchange_type = 'tomography_raw_projections'
>>> )
"""
if (hdf5_file_name != None):
if os.path.isfile(hdf5_file_name):
xtomo.logger.info("Data Exchange file already exists: [%s]. Next time use the Data Exchange reader instead", hdf5_file_name)
else:
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
# Write the Data Exchange HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
xtomo.logger.info("Creating Data Exchange File [%s]", hdf5_file_name)
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
xtomo.logger.info("Adding projections to Data Exchange File [%s]", hdf5_file_name)
f.add_entry( DataExchangeEntry.data(data={'value': data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x' }))
# f.add_entry( DataExchangeEntry.data(data={'value': data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if (theta != None):
f.add_entry( DataExchangeEntry.data(theta={'value': theta, 'units':'degrees'}))
xtomo.logger.info("Adding theta to Data Exchange File [%s]", hdf5_file_name)
if (data_dark != None):
xtomo.logger.info("Adding dark fields to Data Exchange File [%s]", hdf5_file_name)
f.add_entry( DataExchangeEntry.data(data_dark={'value': data_dark, 'units':'counts', 'axes':'theta_dark:y:x' }))
# f.add_entry( DataExchangeEntry.data(data_dark={'value': data_dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if (data_white != None):
xtomo.logger.info("Adding white fields to Data Exchange File [%s]", hdf5_file_name)
f.add_entry( DataExchangeEntry.data(data_white={'value': data_white, 'units':'counts', 'axes':'theta_white:y:x' }))
# f.add_entry( DataExchangeEntry.data(data_white={'value': data_white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if (data_exchange_type != None):
xtomo.logger.info("Adding data type to Data Exchange File [%s]", hdf5_file_name)
f.add_entry( DataExchangeEntry.data(title={'value': data_exchange_type}))
if (sample_name == None):
sample_name = end[0]
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was assigned by the HDF5 converter and based on the HDF5 file name'}))
else:
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was read from the user log file'}))
f.close()
xtomo.logger.info("DONE!!!!. Created Data Exchange File [%s]", hdf5_file_name)
else:
xtomo.logger.info("Nothing to do ...")
def pack_data_exchange():
f = DataExchangeFile(CXP.io.data_exchange_filename, mode='w')
sim = DataExchangeEntry.simulation(
name={'value': 'Simulated Ptycho Data.'},
energy={
'value': CXP.experiment.energy,
'units': 'keV'
},
focusing_optic={'value': CXP.experiment.optic},
probe_modes={'value': CXP.reconstruction.probe_modes},
noise_model={'value': CXP.simulation.noise_model},
gaussian_noise_level={'value': CXP.simulation.gaussian_noise_level},
total_photons={'value': CXP.simulation.total_photons},
beam_stop={'value': CXP.simulation.beam_stop},
beam_stop_size={'value': CXP.simulation.beam_stop_size},
beam_stop_attenuation={'value': CXP.simulation.beam_stop_attenuation},
defocus={'value': CXP.simulation.defocus},
position_jitter={
'value': CXP.reconstruction.initial_position_jitter_radius,
'units': 'pixels'
})
f.add_entry(sim)
sample = DataExchangeEntry.sample(
root='/simulation',
name={'value': 'ground truth sample complex amplitude'},
data={
'value': cxph.sample.data[0],
'units': 'sqrt(counts)'
},
)
f.add_entry(sample)
probe = DataExchangeEntry.sample(
root='/simulation',
entry_name='probe',
)
for mode in range(CXP.reconstruction.probe_modes):
setattr(probe, 'mode_{:d}'.format(mode), {
'value': cxph.input_probe.modes[mode].data[0],
'units': 'counts'
})
f.add_entry(probe)
detector = DataExchangeEntry.detector(
root='/simulation',
x_pixel_size={'value': CXP.experiment.dx_d},
y_pixel_size={'value': CXP.experiment.dx_d},
x_dimension={'value': CXP.experiment.px},
y_dimension={'value': CXP.experiment.py},
distance={'value': CXP.experiment.z},
basis_vectors={
'value': [[0, -CXP.experiment.dx_d, 0],
[-CXP.experiment.dx_d, 0, 0]]
},
corner_position={'value': [0, 0, 0]})
f.add_entry(detector)
data = DataExchangeEntry.data(
name={'value': 'simulated_data'},
data={
'value': sp.array(cxph.det_mod.data),
'axes': 'translation:y:x',
'units': 'counts',
'dataset_opts': {
'compression': 'gzip',
'compression_opts': 4
}
},
translation={'value': '/exchange/sample/geometry/translation'})
f.add_entry(data)
# Get scan positions into dex format
pos = sp.zeros((cxph.positions.total, 3))
y, x = cxph.positions.correct
for i in range(cxph.positions.total):
pos[i, 0], pos[i, 1] = x[i] * CXP.dx_s, y[i] * CXP.dx_s
positions = DataExchangeEntry.translation(
root='/exchange/sample/geometry',
name={'value': 'ptychography scan positions'},
scan_type={'value': CXP.measurement.ptycho_scan_type},
data={
'value': pos,
'units': 'm'
})
f.add_entry(positions)
f.close()
def main():
file_name = '/local/data/databank/TXM_26ID/20130731_004_Stripe_Solder_Sample_Tip1_TomoScript_181imgs_p1s_b1.txrm'
white_file_name = '/local/data/databank/TXM_26ID/20130731_001_Background_Reference_20imgs_p5s_b1.xrm'
hdf5_file_name = '/local/data/databank/dataExchange/TXM/20130731_004_Stripe_Solder_Sample_Tip1_nx.h5'
log_file = '/local/data/databank/dataExchange/TXM/20130731_004_Stripe_Solder_Sample_Tip1.log'
mydata = Convert()
# Create minimal hdf5 file
if verbose: print "Reading data ... "
mydata.stack(file_name,
hdf5_file_name = hdf5_file_name,
white_file_name = white_file_name,
sample_name = 'Stripe_Solder_Sample_Tip1'
)
# Add extra metadata if available / desired
reader = xradia.xrm()
array = dstruct
reader.read_txrm(file_name,array)
# Read angles
n_angles = np.shape(array.exchange.angles)
if verbose: print "Done reading ", n_angles, " angles"
theta = np.zeros(n_angles)
theta = array.exchange.angles[:]
# Save any other available metadata in a log file
f = open(log_file,'w')
f.write('Data creation date: \n')
f.write(str(array.information.file_creation_datetime))
f.write('\n')
f.write('=======================================\n')
f.write('Sample name: \n')
f.write(str(array.information.sample.name))
f.write('\n')
f.write('=======================================\n')
f.write('Experimenter name: \n')
f.write(str(array.information.experimenter.name))
f.write('\n')
f.write('=======================================\n')
f.write('X-ray energy: \n')
f.write(str(array.exchange.energy))
f.write(str(array.exchange.energy_units))
f.write('\n')
f.write('=======================================\n')
f.write('Angles: \n')
f.write(str(array.exchange.angles))
f.write('\n')
f.write('=======================================\n')
f.write('Data axes: \n')
f.write(str(array.exchange.data_axes))
f.write('\n')
f.write('=======================================\n')
f.write('x distance: \n')
f.write(str(array.exchange.x))
f.write('\n')
f.write('=======================================\n')
f.write('x units: \n')
f.write(str(array.exchange.x_units))
f.write('\n')
f.write('=======================================\n')
f.write('y distance: \n')
f.write(str(array.exchange.y))
f.write('\n')
f.write('=======================================\n')
f.write('y units: \n')
f.write(str(array.exchange.y_units))
f.write('\n')
f.close()
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='a')
# Create HDF5 subgroup
# /measurement/instrument
f.add_entry( DataExchangeEntry.instrument(name={'value': 'APS-CNM 26-ID'}) )
### Create HDF5 subgroup
### /measurement/instrument/source
f.add_entry( DataExchangeEntry.source(name={'value': "Advanced Photon Source"},
date_time={'value': "2013-07-31T19:42:13+0100"},
beamline={'value': "26-ID"},
)
)
# Create HDF5 subgroup
# /measurement/instrument/monochromator
f.add_entry( DataExchangeEntry.monochromator(type={'value': 'Unknown'},
energy={'value': float(array.exchange.energy[0]), 'units': 'keV', 'dataset_opts': {'dtype': 'd'}},
mono_stripe={'value': 'Unknown'},
)
)
# Create HDF5 subgroup
# /measurement/experimenter
f.add_entry( DataExchangeEntry.experimenter(name={'value':"Robert Winarski"},
role={'value':"Project PI"},
)
)
# Create HDF5 subgroup
# /measurement/sample
f.add_entry( DataExchangeEntry.data(theta={'value': theta, 'units':'degrees'}))
f.close()
print "Done creating data exchange file: ", hdf5_file_name
def xtomo_exchange(self,
data,
data_white=None,
data_dark=None,
theta=None,
data_exchange_type=None,
source_name=None,
source_mode=None,
source_datetime=None,
beamline=None,
energy=None,
current=None,
actual_pixel_size=None,
experimenter_name=None,
experimenter_affiliation=None,
experimenter_email=None,
instrument_comment=None,
sample_name=None,
sample_comment=None,
acquisition_mode=None,
acquisition_comment=None,
sample_position_x=None,
sample_position_y=None,
sample_position_z=None,
sample_image_shift_x=None,
sample_image_shift_y=None,
hdf5_file_name=None,
axes='theta:y:x',
log='INFO'):
"""
Write 3-D data to a data-exchange file.
Parameters
data : ndarray
3-D X-ray absorption tomography raw data.
Size of the dimensions should be:
[projections, slices, pixels].
data_white, data_dark : ndarray, optional
3-D white-field/dark_field data. Multiple
projections are stacked together to obtain
a 3-D matrix. 2nd and 3rd dimensions should
be the same as data: [shots, slices, pixels].
theta : ndarray, optional
Data acquisition angles corresponding
to each projection.
data_excahnge_type : str, optional
label defyining the type of data contained in data exchange file
for raw data tomography data use 'tomography_raw_projections'
source_name, source_mode, source_datetime : str, optional
label defining the source name, operation mode and date/time when these values were taken
beamline : str, optional
label defining the beamline name
energy, current : float, optional
X-ray energy and bean current
actual_pixel_size : float, optional
pixel size on the sample plane
experimenter_name, experimenter_affiliation, experimenter_email : str, optional
user name, affiliation and e-mail address
instrument_comment : str, optional
instrument comment
sample_name, sample_comment : str, optional
sample name and comment
acquisition_mode, acquisition_comment : str, optional
acquisition mode and comment
hd5_file_name : str
Output file.
Notes
-----
If file exists, does nothing
Examples
- Convert tomographic projection series (raw, dark, white) of tiff in data exchange:
>>> import dataexchange
>>> file_name = '/local/dataraid/databank/Anka/radios/image_.tif'
>>> dark_file_name = '/local/dataraid/databank/Anka/darks/image_.tif'
>>> white_file_name = '/local/dataraid/databank/Anka/flats/image_.tif'
>>> hdf5_file_name = '/local/dataraid/databank/dataExchange/tmp/Anka.h5'
>>> projections_start = 0
>>> projections_end = 3167
>>> white_start = 0
>>> white_end = 100
>>> dark_start = 0
>>> dark_end = 100
>>> sample_name = 'Anka'
>>>
>>> # Read raw data
>>> read = dataexchange.Import()
>>> data, white, dark, theta = read.xtomo_raw(file_name,
>>> projections_start = projections_start,
>>> projections_end = projections_end,
>>> white_file_name = white_file_name,
>>> white_start = white_start,
>>> white_end = white_end,
>>> dark_file_name = dark_file_name,
>>> dark_start = dark_start,
>>> dark_end = dark_end,
>>> projections_digits = 5,
>>> log='INFO'
>>> )
>>>
>>> # Save data
>>> write = dataexchange.Export()
>>> write.xtomo_exchange(data = data,
>>> data_white = white,
>>> data_dark = dark,
>>> theta = theta,
>>> hdf5_file_name = hdf5_file_name,
>>> data_exchange_type = 'tomography_raw_projections',
>>> sample_name = sample_name
>>> )
"""
if (hdf5_file_name != None):
if os.path.isfile(hdf5_file_name):
self.logger.error("Data Exchange file: [%s] already exists",
hdf5_file_name)
else:
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
# Write the Data Exchange HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
self.logger.info("Creating Data Exchange File [%s]",
hdf5_file_name)
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
self.logger.info(
"Adding projections to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data={
'value': data,
'units': 'counts',
'description': 'transmission',
'axes': axes
}))
# f.add_entry( DataExchangeEntry.data(data={'value': data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if (theta != None):
f.add_entry(
DataExchangeEntry.data(theta={
'value': theta,
'units': 'degrees'
}))
self.logger.info("Adding theta to Data Exchange File [%s]",
hdf5_file_name)
else:
self.logger.warning("theta is not defined")
if (data_dark != None):
self.logger.info(
"Adding dark fields to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_dark={
'value': data_dark,
'units': 'counts',
'axes': 'theta_dark:y:x'
}))
# f.add_entry( DataExchangeEntry.data(data_dark={'value': data_dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data dark is not defined")
if (data_white != None):
self.logger.info(
"Adding white fields to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_white={
'value': data_white,
'units': 'counts',
'axes': 'theta_white:y:x'
}))
# f.add_entry( DataExchangeEntry.data(data_white={'value': data_white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data white is not defined")
if (data_exchange_type != None):
self.logger.info(
"Adding data type to Data Exchange File [%s]",
hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
title={'value': data_exchange_type}))
if (source_name != None):
f.add_entry(
DataExchangeEntry.source(name={'value': source_name}))
if (source_mode != None):
f.add_entry(
DataExchangeEntry.source(mode={'value': source_mode}))
if (source_datetime != None):
f.add_entry(
DataExchangeEntry.source(
datetime={'value': source_datetime}))
if (beamline != None):
f.add_entry(
DataExchangeEntry.source(beamline={'value': beamline}))
if (energy != None):
f.add_entry(
DataExchangeEntry.monochromator(
energy={
'value': energy,
'units': 'keV',
'dataset_opts': {
'dtype': 'd'
}
}))
if (current != None):
f.add_entry(
DataExchangeEntry.source(
current={
'value': current,
'units': 'mA',
'dataset_opts': {
'dtype': 'd'
}
}))
if (actual_pixel_size != None):
f.add_entry(
DataExchangeEntry.detector(actual_pixel_size_x={
'value': actual_pixel_size,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
},
actual_pixel_size_y={
'value':
actual_pixel_size,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
if (experimenter_name != None):
f.add_entry(
DataExchangeEntry.experimenter(
name={'value': experimenter_name}))
if (experimenter_affiliation != None):
f.add_entry(
DataExchangeEntry.experimenter(
affiliation={'value': experimenter_affiliation}))
if (experimenter_email != None):
f.add_entry(
DataExchangeEntry.experimenter(
email={'value': experimenter_email}))
if (instrument_comment != None):
f.add_entry(
DataExchangeEntry.instrument(
comment={'value': instrument_comment}))
if (sample_name == None):
sample_name = end[0]
f.add_entry(
DataExchangeEntry.sample(
name={'value': sample_name},
description={
'value':
'Sample name assigned by the HDF5 converter and based on the HDF5 file name'
}))
else:
f.add_entry(
DataExchangeEntry.sample(name={'value': sample_name}))
if (sample_comment != None):
f.add_entry(
DataExchangeEntry.sample(
comment={'value': sample_comment}))
if (acquisition_mode != None):
f.add_entry(
DataExchangeEntry.acquisition(
mode={'value': acquisition_mode}))
if (acquisition_comment != None):
f.add_entry(
DataExchangeEntry.acquisition(
comment={'value': acquisition_comment}))
if (sample_position_x != None):
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_x={
'value': sample_position_x,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
if (sample_position_y != None):
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_y={
'value': sample_position_y,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
if (sample_position_z != None):
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_z={
'value': sample_position_z,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
if (sample_image_shift_x != None):
f.add_entry(
DataExchangeEntry.acquisition(
sample_image_shift_x={
'value': sample_image_shift_x,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
if (sample_image_shift_y != None):
f.add_entry(
DataExchangeEntry.acquisition(
sample_image_shift_y={
'value': sample_image_shift_y,
'units': 'microns',
'dataset_opts': {
'dtype': 'd'
}
}))
f.close()
self.logger.info("DONE!!!!. Created Data Exchange File [%s]",
hdf5_file_name)
else:
self.logger.warning("Nothing to do ...")
def xtomo_exchange(
self,
data,
data_white=None,
data_dark=None,
theta=None,
data_exchange_type=None,
source_name=None,
source_mode=None,
source_datetime=None,
beamline=None,
energy=None,
current=None,
actual_pixel_size=None,
experimenter_name=None,
experimenter_affiliation=None,
experimenter_email=None,
instrument_comment=None,
sample_name=None,
sample_comment=None,
acquisition_mode=None,
acquisition_comment=None,
sample_position_x=None,
sample_position_y=None,
sample_position_z=None,
sample_image_shift_x=None,
sample_image_shift_y=None,
image_exposure_time=None,
image_time=None,
image_theta=None,
hdf5_file_name=None,
axes="theta:y:x",
log="INFO",
):
"""
Write 3-D data to a data-exchange file.
Parameters
data : ndarray
3-D X-ray absorption tomography raw data.
Size of the dimensions should be:
[projections, slices, pixels].
data_white, data_dark : ndarray, optional
3-D white-field/dark_field data. Multiple
projections are stacked together to obtain
a 3-D matrix. 2nd and 3rd dimensions should
be the same as data: [shots, slices, pixels].
theta : ndarray, optional
Data acquisition angles corresponding
to each projection.
data_excahnge_type : str, optional
label defyining the type of data contained in data exchange file
for raw data tomography data use 'tomography_raw_projections'
source_name, source_mode, source_datetime : str, optional
label defining the source name, operation mode and date/time when these values were taken
beamline : str, optional
label defining the beamline name
energy, current : float, optional
X-ray energy and bean current
actual_pixel_size : float, optional
pixel size on the sample plane
experimenter_name, experimenter_affiliation, experimenter_email : str, optional
user name, affiliation and e-mail address
instrument_comment : str, optional
instrument comment
sample_name, sample_comment : str, optional
sample name and comment
acquisition_mode, acquisition_comment : str, optional
acquisition mode and comment
hd5_file_name : str
Output file.
Notes
-----
If file exists, does nothing
Examples
- Convert tomographic projection series (raw, dark, white) of tiff in data exchange:
>>> import dataexchange
>>> file_name = '/local/dataraid/databank/Anka/radios/image_.tif'
>>> dark_file_name = '/local/dataraid/databank/Anka/darks/image_.tif'
>>> white_file_name = '/local/dataraid/databank/Anka/flats/image_.tif'
>>> hdf5_file_name = '/local/dataraid/databank/dataExchange/tmp/Anka.h5'
>>> projections_start = 0
>>> projections_end = 3167
>>> white_start = 0
>>> white_end = 100
>>> dark_start = 0
>>> dark_end = 100
>>> sample_name = 'Anka'
>>>
>>> # Read raw data
>>> read = dataexchange.Import()
>>> data, white, dark, theta = read.xtomo_raw(file_name,
>>> projections_start = projections_start,
>>> projections_end = projections_end,
>>> white_file_name = white_file_name,
>>> white_start = white_start,
>>> white_end = white_end,
>>> dark_file_name = dark_file_name,
>>> dark_start = dark_start,
>>> dark_end = dark_end,
>>> projections_digits = 5,
>>> log='INFO'
>>> )
>>>
>>> # Save data
>>> write = dataexchange.Export()
>>> write.xtomo_exchange(data = data,
>>> data_white = white,
>>> data_dark = dark,
>>> theta = theta,
>>> hdf5_file_name = hdf5_file_name,
>>> data_exchange_type = 'tomography_raw_projections',
>>> sample_name = sample_name
>>> )
"""
if hdf5_file_name != None:
if os.path.isfile(hdf5_file_name):
self.logger.error("Data Exchange file: [%s] already exists", hdf5_file_name)
else:
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split(".")
# Write the Data Exchange HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode="w")
self.logger.info("Creating Data Exchange File [%s]", hdf5_file_name)
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
self.logger.info("Adding projections to Data Exchange File [%s]", hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data={"value": data, "units": "counts", "description": "transmission", "axes": axes}
)
)
# f.add_entry( DataExchangeEntry.data(data={'value': data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
if theta != None:
f.add_entry(DataExchangeEntry.data(theta={"value": theta, "units": "degrees"}))
self.logger.info("Adding theta to Data Exchange File [%s]", hdf5_file_name)
else:
self.logger.warning("theta is not defined")
if data_dark != None:
self.logger.info("Adding dark fields to Data Exchange File [%s]", hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_dark={"value": data_dark, "units": "counts", "axes": "theta_dark:y:x"}
)
)
# f.add_entry( DataExchangeEntry.data(data_dark={'value': data_dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data dark is not defined")
if data_white != None:
self.logger.info("Adding white fields to Data Exchange File [%s]", hdf5_file_name)
f.add_entry(
DataExchangeEntry.data(
data_white={"value": data_white, "units": "counts", "axes": "theta_white:y:x"}
)
)
# f.add_entry( DataExchangeEntry.data(data_white={'value': data_white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
else:
self.logger.warning("data white is not defined")
if data_exchange_type != None:
self.logger.info("Adding data type to Data Exchange File [%s]", hdf5_file_name)
f.add_entry(DataExchangeEntry.data(title={"value": data_exchange_type}))
if source_name != None:
f.add_entry(DataExchangeEntry.source(name={"value": source_name}))
if source_mode != None:
f.add_entry(DataExchangeEntry.source(mode={"value": source_mode}))
if source_datetime != None:
f.add_entry(DataExchangeEntry.source(datetime={"value": source_datetime}))
if beamline != None:
f.add_entry(DataExchangeEntry.source(beamline={"value": beamline}))
if energy != None:
f.add_entry(
DataExchangeEntry.monochromator(
energy={"value": energy, "units": "keV", "dataset_opts": {"dtype": "d"}}
)
)
if current != None:
f.add_entry(
DataExchangeEntry.source(
current={"value": current, "units": "mA", "dataset_opts": {"dtype": "d"}}
)
)
if actual_pixel_size != None:
f.add_entry(
DataExchangeEntry.detector(
actual_pixel_size_x={
"value": actual_pixel_size,
"units": "microns",
"dataset_opts": {"dtype": "d"},
},
actual_pixel_size_y={
"value": actual_pixel_size,
"units": "microns",
"dataset_opts": {"dtype": "d"},
},
)
)
if experimenter_name != None:
f.add_entry(DataExchangeEntry.experimenter(name={"value": experimenter_name}))
if experimenter_affiliation != None:
f.add_entry(DataExchangeEntry.experimenter(affiliation={"value": experimenter_affiliation}))
if experimenter_email != None:
f.add_entry(DataExchangeEntry.experimenter(email={"value": experimenter_email}))
if instrument_comment != None:
f.add_entry(DataExchangeEntry.instrument(comment={"value": instrument_comment}))
if sample_name == None:
sample_name = end[0]
f.add_entry(
DataExchangeEntry.sample(
name={"value": sample_name},
description={
"value": "Sample name assigned by the HDF5 converter and based on the HDF5 file name"
},
)
)
else:
f.add_entry(DataExchangeEntry.sample(name={"value": sample_name}))
if sample_comment != None:
f.add_entry(DataExchangeEntry.sample(comment={"value": sample_comment}))
if acquisition_mode != None:
f.add_entry(DataExchangeEntry.acquisition(mode={"value": acquisition_mode}))
if acquisition_comment != None:
f.add_entry(DataExchangeEntry.acquisition(comment={"value": acquisition_comment}))
if sample_position_x != None:
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_x={
"value": sample_position_x,
"units": "microns",
"dataset_opts": {"dtype": "d"},
}
)
)
if sample_position_y != None:
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_y={
"value": sample_position_y,
"units": "microns",
"dataset_opts": {"dtype": "d"},
}
)
)
if sample_position_z != None:
f.add_entry(
DataExchangeEntry.acquisition(
sample_position_z={
"value": sample_position_z,
"units": "microns",
"dataset_opts": {"dtype": "d"},
}
)
)
if sample_image_shift_x != None:
f.add_entry(
DataExchangeEntry.acquisition(
sample_image_shift_x={
"value": sample_image_shift_x,
"units": "microns",
"dataset_opts": {"dtype": "d"},
}
)
)
if sample_image_shift_y != None:
f.add_entry(
DataExchangeEntry.acquisition(
sample_image_shift_y={
"value": sample_image_shift_y,
"units": "microns",
"dataset_opts": {"dtype": "d"},
}
)
)
if image_exposure_time != None:
f.add_entry(
DataExchangeEntry.acquisition(
image_exposure_time={
"value": image_exposure_time,
"units": "s",
"dataset_opts": {"dtype": "d"},
}
)
)
if image_time != None:
f.add_entry(DataExchangeEntry.acquisition(image_time={"value": image_time}))
if image_theta != None:
f.add_entry(DataExchangeEntry.acquisition(image_theta={"value": image_theta, "units": "degrees"}))
f.close()
self.logger.info("DONE!!!!. Created Data Exchange File [%s]", hdf5_file_name)
else:
self.logger.warning("Nothing to do ...")
def series_of_images(self, file_name,
hdf5_file_name,
projections_start=0,
projections_end=0,
projections_step=1,
projections_angle_range=180,
slices_start=None,
slices_end=None,
slices_step=None,
pixels_start=None,
pixels_end=None,
pixels_step=None,
white_file_name=None,
white_start=0,
white_end=0,
white_step=1,
dark_file_name=None,
dark_start=0,
dark_end=0,
dark_step=1,
projections_digits=4,
white_digits=-1,
dark_digits=-1,
zeros=True,
dtype='uint16',
data_type='tiff',
sample_name=None,
verbose=True):
"""Read a stack of HDF-4 or TIFF files in a folder.
Parameters
----------
file_name : str
Base name of the input HDF-4 or TIFF files.
For example if the projections names are /local/data/test_XXXX.hdf
file_name is /local/data/test_.hdf
hdf5_file_name : str
HDF5/data exchange file name
projections_start, projections_end, projections_step : scalar, optional
start and end index for the projection Tiff files to load. Use step define a stride.
slices_start, slices_end, slices_step : scalar, optional
start and end pixel of the projection image to load along the rotation axis. Use step define a stride.
pixels_start, pixels_end, pixels_step : not used yet.
white_file_name : str
Base name of the white field input HDF-4 or TIFF files: string optional.
For example if the white field names are /local/data/test_bg_XXXX.hdf
file_name is /local/data/test_bg_.hdf
if omitted white_file_name = file_name.
white_start, white_end : scalar, optional
start and end index for the white field Tiff files to load. Use step define a stride.
dark_file_name : str
Base name of the dark field input HDF-4 or TIFF files: string optinal.
For example if the white field names are /local/data/test_dk_XXXX.hdf
file_name is /local/data/test_dk_.hdf
if omitted dark_file_name = file_name.
dark_start, dark_end : scalar, optional
start and end index for the dark field Tiff files to load. Use step define a stride.
projections_digits : scalar, optional
Number of projections_digits used for file indexing.
For example if 4: test_XXXX.hdf
zeros : bool, optional
If ``True`` assumes all indexing uses four projections_digits
(0001, 0002, ..., 9999). If ``False`` omits zeros in
indexing (1, 2, ..., 9999)
dtype : str, optional
Corresponding Numpy data type of the HDF-4 or TIFF file.
data_type : str, optional
if 'hdf4q m ' will convert HDF-4 files (old 2-BM), deafult is 'tiff'
Returns
-------
inputData : list of hdf files contating projections, white and dark images
Output : saves the data as HDF5 in hdf5_file_name
.. See also:: http://docs.scipy.org/doc/numpy/user/basics.types.html
"""
# Initialize f to null.
hdf5_file_extension = False
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
logger.info(end)
# If the string has an extension.
if len(end) > 1:
# Check.
if end[len(end) - 1] == 'h5' or end[len(end) - 1] == 'hdf':
hdf5_file_extension = True
logger.info("HDF file extension is .h5 or .hdf")
else:
hdf5_file_extension = False
logger.info("HDF file extension must be .h5 or .hdf")
# If the extension is correct and the file does not exists then convert
if (hdf5_file_extension and (os.path.isfile(hdf5_file_name) == False)):
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Prepare hdf file names to be read.
if white_file_name == None:
white_file_name = file_name
logger.info("File Name White = %s", white_file_name)
if dark_file_name == None:
dark_file_name = file_name
logger.info("File Name Dark = %s", dark_file_name)
logger.info("File Name Projections = %s", file_name)
logger.info("File Name White = %s", white_file_name)
logger.info("File Name Dark = %s", dark_file_name)
# Set default digits.
if white_digits == -1:
white_digits = projections_digits
logger.info("White digits = %s", white_digits)
if dark_digits == -1:
dark_digits = projections_digits
logger.info("Dark digits= %s", dark_digits)
if (data_type is 'hdf4'):
if file_name.endswith('h4') or \
file_name.endswith('hdf'):
dataFile = file_name.split('.')[-2]
dataExtension = file_name.split('.')[-1]
if white_file_name.endswith('h4') or \
white_file_name.endswith('hdf'):
dataFileWhite = white_file_name.split('.')[-2]
dataExtensionWhite = white_file_name.split('.')[-1]
if dark_file_name.endswith('h4') or \
dark_file_name.endswith('hdf'):
dataFileDark = dark_file_name.split('.')[-2]
dataExtensionDark = dark_file_name.split('.')[-1]
else:
if file_name.endswith('tif') or \
file_name.endswith('tiff'):
dataFile = file_name.split('.')[-2]
dataExtension = file_name.split('.')[-1]
if white_file_name.endswith('tif') or \
white_file_name.endswith('tiff'):
dataFileWhite = white_file_name.split('.')[-2]
dataExtensionWhite = white_file_name.split('.')[-1]
if dark_file_name.endswith('tif') or \
dark_file_name.endswith('tiff'):
dataFileDark = dark_file_name.split('.')[-2]
dataExtensionDark = dark_file_name.split('.')[-1]
projections_file_index = ["" for x in range(projections_digits)]
for m in range(projections_digits):
if zeros is True:
projections_file_index[m] = '0' * (projections_digits - m - 1)
elif zeros is False:
projections_file_index[m] = ''
white_file_index = ["" for x in range(white_digits)]
for m in range(white_digits):
if zeros is True:
white_file_index[m] = '0' * (white_digits - m - 1)
elif zeros is False:
white_file_index[m] = ''
dark_file_index = ["" for x in range(dark_digits)]
for m in range(dark_digits):
if zeros is True:
dark_file_index[m] = '0' * (dark_digits - m - 1)
elif zeros is False:
dark_file_index[m] = ''
# Reading projections.
ind = range(projections_start, projections_end)
logger.info("projections: Start = %d, End = %d, Step = %d", projections_start, projections_end, projections_step)
for m in range(len(ind)):
for n in range(projections_digits):
logger.info("n = %d, ind[m] %d < %d", n, ind[m], np.power(10, n + 1))
if ind[m] < np.power(10, n + 1):
fileName = dataFile + projections_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info("Generating file names: %s", fileName)
break
if os.path.isfile(fileName):
logger.info("Reading projection file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'hdf4'):
f = Hdf4()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
array_name = 'data'
)
else:
f = Tiff()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
dtype=dtype
)
if m == 0: # Get resolution once.
inputData = np.empty((projections_end-projections_start,
tmpdata.shape[0],
tmpdata.shape[1]),
dtype=dtype
)
inputData[m, :, :] = tmpdata
if len(ind) > 0:
self.data = inputData
# Reading white fields.
ind = range(white_start, white_end, white_step)
logger.info("white: Start = %d, End = %d, Step = %d", white_start, white_end, white_step)
for m in range(len(ind)):
for n in range(white_digits):
logger.info("n = %d, ind[m] %d < %d", n, ind[m], np.power(10, n + 1))
if ind[m] < np.power(10, n + 1):
fileName = dataFileWhite + white_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info(fileName)
break
if os.path.isfile(fileName):
logger.info("Reading white file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'hdf4'):
f = Hdf4()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
array_name = 'data'
)
else:
f = Tiff()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
dtype=dtype
)
if m == 0: # Get resolution once.
inputData = np.empty(((white_end - white_start)/white_step + 1,
tmpdata.shape[0],
tmpdata.shape[1]),
dtype=dtype
)
inputData[m, :, :] = tmpdata
if len(ind) > 0:
self.white = inputData
# Reading dark fields.
ind = range(dark_start, dark_end, dark_step)
logger.info("dark: Start = %d, End = %d, Step = %d", dark_start, dark_end, dark_step)
for m in range(len(ind)):
for n in range(dark_digits):
if ind[m] < np.power(10, n + 1):
fileName = dataFileDark + dark_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info(fileName)
break
if os.path.isfile(fileName):
logger.info("Reading dark file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'hdf4'):
f = Hdf4()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
array_name = 'data'
)
else:
f = Tiff()
tmpdata = f.read(fileName,
x_start=slices_start,
x_end=slices_end,
x_step=slices_step,
dtype=dtype
)
if m == 0: # Get resolution once.
inputData = np.empty(((dark_end - dark_start),
tmpdata.shape[0],
tmpdata.shape[1]),
dtype=dtype
)
inputData[m, :, :] = tmpdata
if len(ind) > 0:
self.dark = inputData
# Fabricate theta values.
z = np.arange(projections_end - projections_start);
# Fabricate theta values
self.theta = (z * float(projections_angle_range) / (len(z) - 1))
# Write HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': self.data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(theta={'value': self.theta, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(data_dark={'value': self.dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(data_white={'value': self.white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(title={'value': 'tomography_raw_projections'}))
logger.info("Sample name = %s", sample_name)
if (sample_name == None):
sample_name = end[0]
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was assigned by the HDF5 converter and based on the HDF5 fine name'}))
logger.info("Assigned default file name: %s", end[0])
else:
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was read from the user log file'}))
logger.info("Assigned file name from user log")
f.close()
else:
if os.path.isfile(hdf5_file_name):
print 'HDF5 already exists. Nothing to do ...'
if (hdf5_file_extension == False):
print "HDF file extension must be .h5 or .hdf"
def write_example(filename):
# --- prepare data ---
# Generate fake raw data
rawdata = np.ones(180 * 256 * 256, np.uint16).reshape(180, 256, 256)
# x, y and z ranges
x = np.arange(128)
y = np.arange(128)
z = np.arange(180)
# --- create file ---
# Open HDF5 file
f = DataExchangeFile(filename, mode='w')
# Create core HDF5 dataset in exchange group for 180 deep stack of x,y
# images /exchange/data
f.add_entry(
DataExchangeEntry.data(
data={
'value': rawdata,
'units': 'counts',
'description': 'Projection Data',
'dataset_opts': {
'compression': 'gzip',
'compression_opts': 4
}
}))
# Create HDF5 subgroup
# /measurement/sample
f.add_entry(
DataExchangeEntry.sample(name={'value': 'Minivirus'},
temperature={
'value': 200.0,
'units': 'celsius',
'dataset_opts': {
'dtype': 'd'
}
}))
# Create HDF5 subgroup
# /measurement/instrument
f.add_entry(DataExchangeEntry.instrument(name={'value': 'APS 2-BM'}))
# Create HDF5 subgroup
# /measurement/instrument/monochromator
f.add_entry(
DataExchangeEntry.monochromator(name={'value': 'DMM'},
energy={
'value': 10.00,
'units': 'keV',
'dataset_opts': {
'dtype': 'd'
}
}))
# --- All done ---
f.close()
def multiple_stack(self, file_name,
hdf5_file_name,
projections_start=0,
projections_end=1,
projections_step=1,
white_file_name=None,
white_start=0,
white_end=0,
white_step=1,
dark_file_name=None,
dark_start=0,
dark_end=0,
dark_step=1,
projections_digits=4,
white_digits=-1,
dark_digits=-1,
zeros=False,
data_type='spe',
sample_name=None,
verbose=False):
"""Read a stack spe files. Each SPE file contains a stack of projections/white images
Parameters
----------
file_name : str
Base name of the input SPE files.
For example if the projection file names are /local/data/test_XXXX.SPE
file_name is /local/data/test_.hdf
projections_start, projections_end, projections_step : scalar, optional
start and end index for the projection Tiff files to load. Use step define a stride.
white_file_name : str
Base name of the white field input SPE files: string optional.
For example if the white field names are /local/data/test_bg_XXXX.SPE
file_name is /local/data/test_bg_.SPE
if omitted white_file_name = file_name.
white_start, white_end, white_step : scalar, optional
start and end index for the white field SPE files to load.
white_step defines the stride.
dark_file_name : str
Base name of the dark field input SPE files: string optinal.
For example if the white field names are /local/data/test_dk_XXXX.SPE
file_name is /local/data/test_dk_.SPE
if omitted dark_file_name = file_name.
dark_start, dark_end, dark_step : scalar, optional
start and end index for the dark field Tiff files to load.
dark_step defines the stride.
projections_digits : scalar, optional
Number of projections_digits used for file indexing.
For example if 4: test_XXXX.hdf
zeros : bool, optional
If ``True`` assumes all indexing uses four projections_digits
(0001, 0002, ..., 9999). If ``False`` omits zeros in
indexing (1, 2, ..., 9999)
data_type : str, optional
Not used
hdf5_file_name : str
HDF5/data exchange file name
Returns
-------
Output : saves the data as HDF5 in hdf5_file_name
.. See also:: http://docs.scipy.org/doc/numpy/user/basics.types.html
"""
logger.info("Call to multiple_stack")
# Initialize f to null.
hdf5_file_extension = False
# Get the file_name in lower case.
lFn = hdf5_file_name.lower()
# Split the string with the delimeter '.'
end = lFn.split('.')
logger.info(end)
# If the string has an extension.
if len(end) > 1:
# Check.
if end[len(end) - 1] == 'h5' or end[len(end) - 1] == 'hdf':
hdf5_file_extension = True
logger.info("HDF file extension is .h5 or .hdf")
else:
hdf5_file_extension = False
logger.info("HDF file extension must be .h5 or .hdf")
# If the extension is correct and the file does not exists then convert
if (hdf5_file_extension and (os.path.isfile(hdf5_file_name) == False)):
# Create new folder.
dirPath = os.path.dirname(hdf5_file_name)
if not os.path.exists(dirPath):
os.makedirs(dirPath)
# Prepare hdf file names to be read.
if white_file_name == None:
white_file_name = file_name
logger.info("File Name White = %s", white_file_name)
if dark_file_name == None:
dark_file_name = file_name
logger.info("File Name Dark = %s", dark_file_name)
logger.info("File Name Projections = %s", file_name)
logger.info("File Name White = %s", white_file_name)
logger.info("File Name Dark = %s", dark_file_name)
# Set default digits.
if white_digits == -1:
white_digits = projections_digits
logger.info("White digits = %s", white_digits)
if dark_digits == -1:
dark_digits = projections_digits
logger.info("Dark digits= %s", dark_digits)
if (data_type is 'spe'):
if file_name.endswith('SPE') or \
file_name.endswith('spe'):
dataFile = file_name.split('.')[-2]
dataExtension = file_name.split('.')[-1]
if white_file_name.endswith('SPE') or \
white_file_name.endswith('spe'):
dataFileWhite = white_file_name.split('.')[-2]
dataExtensionWhite = white_file_name.split('.')[-1]
if dark_file_name.endswith('SPE') or \
dark_file_name.endswith('spe'):
dataFileDark = dark_file_name.split('.')[-2]
dataExtensionDark = dark_file_name.split('.')[-1]
projections_file_index = ["" for x in range(projections_digits)]
for m in range(projections_digits):
if zeros is True:
projections_file_index[m] = '0' * (projections_digits - m - 1)
elif zeros is False:
projections_file_index[m] = ''
white_file_index = ["" for x in range(white_digits)]
for m in range(white_digits):
if zeros is True:
white_file_index[m] = '0' * (white_digits - m - 1)
elif zeros is False:
white_file_index[m] = ''
dark_file_index = ["" for x in range(dark_digits)]
for m in range(dark_digits):
if zeros is True:
dark_file_index[m] = '0' * (dark_digits - m - 1)
elif zeros is False:
dark_file_index[m] = ''
# Reading projections.
fileName = ''
ind = range(projections_start, projections_end, projections_step)
logger.info("projections: Start = %d, End = %d, Step = %d", projections_start, projections_end, projections_step)
for m in range(len(ind)):
for n in range(projections_digits):
logger.info("n = %d, ind[m] %d < %d", n, ind[m], np.power(10, n + 1))
if ind[m] < np.power(10, n + 1):
fileName = dataFile + projections_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info("Generating file names: %s", fileName)
break
if os.path.isfile(fileName):
spe_data = spe.PrincetonSPEFile(fileName)
logger.info(spe_data)
logger.info("Reading projections file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'spe'):
f = Spe()
tmpdata = f.read(fileName)
logger.info("tmpData: %d, %d, %d", tmpdata.shape[0], tmpdata.shape[1], tmpdata.shape[2])
if m == 0: # Get resolution once.
inputData = np.vstack([tmpdata])
else:
inputData = np.concatenate((inputData, tmpdata), axis=0)
logger.info("InputData: %d, %d, %d", inputData.shape[0], inputData.shape[1], inputData.shape[2])
if len(ind) > 0:
self.data = inputData
logger.info("Done loading projections")
logger.info("Data: %d, %d, %d", self.data.shape[0], self.data.shape[1], self.data.shape[2])
# Reading white.
fileName = ''
ind = range(white_start, white_end, white_step)
logger.info("white: Start = %d, End = %d, Step = %d", white_start, white_end, white_step)
for m in range(len(ind)):
for n in range(white_digits):
if ind[m] < np.power(10, n + 1):
fileName = dataFile + white_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info("Generating file names: %s", fileName)
break
if os.path.isfile(fileName):
spe_data = spe.PrincetonSPEFile(fileName)
logger.info(spe_data)
logger.info("Reading white file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'spe'):
f = Spe()
tmpdata = f.read(fileName)
logger.info("tmpData: %d, %d, %d", tmpdata.shape[0], tmpdata.shape[1], tmpdata.shape[2])
if m == 0: # Get resolution once.
inputData = np.vstack([tmpdata])
else:
inputData = np.concatenate((inputData, tmpdata), axis=0)
logger.info("InputData: %d, %d, %d", inputData.shape[0], inputData.shape[1], inputData.shape[2])
if len(ind) > 0:
self.white = inputData
logger.info("Done loading white")
logger.info("WhiteData: %d, %d, %d", self.white.shape[0], self.white.shape[1], self.white.shape[2])
else:
nx, ny, nz = np.shape(self.data)
self.white = np.ones((1, ny, nx))
# Reading dark.
fileName = ''
ind = range(dark_start, dark_end, dark_step)
logger.info("dark: Start = %d, End = %d, Step = %d", dark_start, dark_end, dark_step)
for m in range(len(ind)):
for n in range(dark_digits):
logger.info("n = %d, ind[m] %d < %d", n, ind[m], np.power(10, n + 1))
if ind[m] < np.power(10, n + 1):
fileName = dataFile + dark_file_index[n] + str(ind[m]) + '.' + dataExtension
logger.info("Generating file names: %s", fileName)
break
if os.path.isfile(fileName):
spe_data = spe.PrincetonSPEFile(fileName)
logger.info(spe_data)
logger.info("Reading dark file: %s", os.path.realpath(fileName))
logger.info("data type: %s", data_type)
if (data_type is 'spe'):
f = Spe()
tmpdata = f.read(fileName)
logger.info("tmpData: %d, %d, %d", tmpdata.shape[0], tmpdata.shape[1], tmpdata.shape[2])
if m == 0: # Get resolution once.
inputData = np.vstack([tmpdata])
else:
inputData = np.concatenate((inputData, tmpdata), axis=0)
logger.info("InputData: %d, %d, %d", inputData.shape[0], inputData.shape[1], inputData.shape[2])
if len(ind) > 0:
self.dark = inputData
logger.info("Done loading dark")
logger.info(self.dark.shape[0], self.dark.shape[1], self.dark.shape[2])
else:
nx, ny, nz = np.shape(self.data)
self.dark = np.zeros((1, ny, nx))
# Write HDF5 file.
# Open DataExchange file
f = DataExchangeFile(hdf5_file_name, mode='w')
logger.info("Writing the HDF5 file")
# Create core HDF5 dataset in exchange group for projections_theta_range
# deep stack of x,y images /exchange/data
f.add_entry( DataExchangeEntry.data(data={'value': self.data, 'units':'counts', 'description': 'transmission', 'axes':'theta:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(theta={'value': self.theta, 'units':'degrees'}))
f.add_entry( DataExchangeEntry.data(data_dark={'value': self.dark, 'units':'counts', 'axes':'theta_dark:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(data_white={'value': self.white, 'units':'counts', 'axes':'theta_white:y:x', 'dataset_opts': {'compression': 'gzip', 'compression_opts': 4} }))
f.add_entry( DataExchangeEntry.data(title={'value': 'tomography_raw_projections'}))
logger.info("Sample name = %s", sample_name)
if (sample_name == None):
sample_name = end[0]
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was assigned by the HDF5 converter and based on the HDF5 fine name'}))
logger.info("Assigned default file name: %s", end[0])
else:
f.add_entry( DataExchangeEntry.sample( name={'value':sample_name}, description={'value':'Sample name was read from the user log file'}))
logger.info("Assigned file name from user log")
f.close()
else:
if os.path.isfile(hdf5_file_name):
print 'HDF5 already exists. Nothing to do ...'
if (hdf5_file_extension == False):
print "HDF file extension must be .h5 or .hdf"