pyhsafm

このモジュールはHS-AFMで撮影された画像をPython3上で処理するためのモジュールです。 OpenCV v3用の画像を出力することができ、必要に応じてOpenCV v3との連携が可能です。
使用する際は、afmimprocをインポートしてください。

使い方

imwrite
imwrite_gray
imwrite
imwrite_gray
imshow
imshow_gray
imshow_opencv
implay
histogram
threshold_otsu
binarize
apply_mask
heightCorrection
tiltCorrection
heightScaling
highpass_filter
lowpass_filter
bandpass_filter
find_edge
enhance_edge
median_filter
convolution_filter
average_filter
gaussian_filter
laplacian_filter
sharpen_filter

依存関係

このモジュールは numpy, scipy, opencv-python, numba, sklearn に依存します。以下のコマンドでインストールを行ってください。

$ pip3 install numpy scipy opencv-python numba sklearn

インポート方法

import sys
sys.path.append('pyhsafmをgit cloneしたディレクトリ')
import afmimproc as aip

クラス

AfmImg

AfmImg(data, XYlength, idx = None, frame_header = None)

HS-AFM像を扱うためのクラスです。 HS-AFM像が持つXY方向の距離などの情報を扱うことができます。
直接データを渡してインスタンスを作成することも可能ですが、後述するASD_readerを利用することを推奨します。

引数
data : 高さ情報の2次元リスト
XYlength : XY方向の長さ(nm)のリスト [x, y]
idx : 画像のインデックス（オプション）
frame_header : 画像のメタ情報（オプション）

メソッド

AfmImg.copy()
自身の深いコピーを生成します。

AfmImg.getOpenCVimageGray()
OpenCV互換の8bitグレースケール画像を出力します。

AfmImg.getOpenCVimage()
OpenCV互換の8bitカラー画像を出力します。

AfmImg.getOpenCVColorMap()
OpenCV互換の8bitカラーマップを出力します。

AfmImg[y0:y1,x0:x1]
画像をy0からy1, x0からx1の範囲で切り抜きます。
元の画像の一部への参照ではなくコピーを返す ことに注意してください。
また、この方法で生成された画像はメンバ変数idxおよびframe_headerを持っていません。

メンバ変数

AfmImg.data : 二次元ndarray（numpyリスト）
高さ情報の生データへのアクセスができます。

AfmImg.shape : 要素数2のリスト
OpenCVと同じフォーマットで画像のサイズを持っています。

AfmImg.zdata : 要素数2のリスト
高さの最小値、最大値を持っています。

AfmImg.XYlength : 要素数2のリスト
XY方向の実際の長さ（測定時のスキャンサイズ）を持っています。

AfmImg.lenppixel : 数値
1ピクセルあたりの実際の長さです。画像上でのピクセル数と積を取ることで実際の長さを求めることができます。

AfmImg.ns2ppixel : 数値
1ピクセルあたりの実際の面積です。画像上で算出されるピクセルでの面積と積を取ることで実際の面積を求めることができます。
応用として、ns2ppixelと高さの積を取ることでそのピクセルの体積を計算することができます。この計算を他のピクセルに対しても適用し、総和を取ることで領域の体積を求めることができます。

AfmImg.idx : 整数
ASDファイル内でのフレーム番号を持っています。

AfmImg.frame_header : 辞書型リスト
測定時に付加されたヘッダーファイルの生データにアクセスできます。
次に示すキーを持っています。

['CurrentNum', 'MaxData', 'MiniData', 'XOffset', 'YOffset', 'XTilt', 'YTilt', 'LaserFlag', 'Reserved', 'Reserved', 'Reserved', 'Reserved']

ASD_reader

ASD_reader(path)

HS-AFMのASDファイルを読み込むためのクラスです。

引数
path : 読み込むASDファイルのパス

メソッド

ASD_reader[idx] or ASD_reader[start:stop:step]

ファイル読み書きに使用するopenと同様にwith文に対応しています。読み込まれた一連の画像は、インデックスを使用してアクセスすることが可能です。アクセスするごとに新たなAfmImgインスタンスが生成される ことに注意してください。

メンバ変数

ASD_reader.frame_time : 数値
フレームあたりの時間を持っています。

ASD_reader.comment : 文字列
測定時に付加されたコメントを持っています。

ASD_reader.date : datetimeオブジェクト
測定の日時をdatetime型で持っています。

ASD_reader.header : 辞書型リスト
測定時に付加されたヘッダーファイルの生データにアクセスできます。
次に示すキーを持っています。

['FileType','FileHeaderSizeForSave', 'FrameHeaderSize', 'TextEncoding', 'OpeNameSize', 'CommentSizeForSave', 'DataType1ch', 'DataType2ch', 'FrameNum', 'ImageNum', 'ScanDirection', 'ScanTryNum', 'XPixel', 'YPixel', 'XScanSize', 'YScanSize', 'AveFlag', 'AverageNum', 'Year', 'Month', 'Day', 'Hour', 'Minute', 'Second', 'XRound', 'YRound', 'FrameTime', 'Sensitivity', 'PhaseSens', 'Offset1', 'Offset2', 'Offset3', 'Offset4', 'MachineNo', 'ADRange', 'ADResolution', 'MaxScanSizeX', 'MaxScanSizeY', 'PiezoConstX', 'PiezoConstY', 'PiezoConstZ', 'DriverGainZ', 'Comment']

使用例

import afmimproc as aip

with aip.ASD_reader('test.asd') as imgs:  #with文でASDファイルをimgsとして開く
  #測定日を表示
  print(imgs.date)

  #コメントを表示
  print(imgs.comment)

  #1フレーム目を読み込んで表示
  img0 = imgs[0]
  aip.imshow(img0)

  #全フレームを順番に表示
  for img in imgs:
    aip.imshow(img)

  #101フレームから200フレームまで順番に表示
  for img in imgs[100:200]:
    aip.imshow(img)

  #201フレームから300フレームまで2フレームごとに表示
  for img in imgs[200:300:2]:
    aip.imshow(img)

関数

imwrite

imwrite(path, img)

AfmImgをカラーの画像ファイルとして出力する関数です。拡張子で形式を指定することができます。

引数
path : 出力する画像ファイルのパス
img : 出力するAfmImg形式の画像

戻り値
なし

imwrite_gray

imwrite_gray(path, img)

AfmImgをグレースケールの画像ファイルとして出力する関数です。拡張子で形式を指定することができます。

引数
path : 出力する画像ファイルのパス
img : 出力するAfmImg形式の画像

戻り値
なし

imshow

imshow(img, text='')

AfmImgをカラーの画像ファイルとして表示する関数です。

引数
img : 表示するAfmImg形式の画像
text : 表示するウィンドウのタイトル（オプション）

戻り値
なし

imshow_gray

imshow_gray(img, text='')

AfmImgをグレースケールの画像ファイルとして表示する関数です。

引数
img : 表示するAfmImg形式の画像
text : 表示するウィンドウのタイトル（オプション）

戻り値
なし

imshow_opencv

imshow_opencv(img, text='')

OepnCVの画像を表示する関数です。

引数
img : 表示するOepnCV形式の画像
text : 表示するウィンドウのタイトル（オプション）

戻り値
なし

implay

implay(imgs, idx=None, time=True, func=None, args=None)

ASD_readerの画像を連続で表示する関数です。
キーボード入力で操作します。
f: 次の画像(forward)
b: 前の画像(backward)
Esc：終了

引数
imgs : 表示するASD_readerのインスタンス
idx : 表示する範囲 [start, stop]（オプション）
time：時間を表示するかどうか（オプション）
func：画像に対する処理を書いた関数（オプション）
args：funcに渡す引数のリスト（オプション）

戻り値
なし

funcとして画像に対する処理を記述した関数を渡すことができます。
argsは必ず引数として渡されますが、関数内で使用しなくても構いません。
funcは以下の条件で作成してください。
引数
src : 処理を行うAfmImg形式の画像
args：funcに渡す引数のリスト

戻り値
dst : OpenCV形式の画像

histogram

histogram(img, range=None, step=0.1, order=None, smoothed=False, smoothing_order=3, mask=None)

画像のヒストグラムとそのピークリストを生成する関数です。

引数
img : AfmImg形式の画像
range : リスト（オプション）
ヒストグラム作成に使用する高さの範囲 [min, max]
step : 数値（オプション）
ヒストグラム作成時の高さの幅
order : 整数（オプション）
ピーク検出時に比較を行う幅の値
smoothed : bool型（オプション）
ヒストグラムを平滑化するかどうか
smoothing_order : 整数（オプション）
ヒストグラム平滑化の際に、平均を取る範囲
mask : マスク（オプション）
マスクされた部分を除いてヒストグラムを生成する

戻り値
hist : リスト
ヒストグラムのY軸の値
hist_bins : リスト
ヒストグラムのラベル（X軸の値）
peaks : リスト
ヒストグラム上のピーク。hist_binsのインデックスとして出力されます。

threshold_otsu

threshold_otsu(img, mask=None)

大津の二値化に用いるしきい値を高さとして出力します。

引数
img : AfmImg形式の画像 mask : マスク（オプション）マスクされた部分を除いてしきい値を生成する

戻り値
threshold : 数値
大津の二値化に用いるしきい値

binarize

binarize(src, lowest, highest=None)

二値化した画像を出力します。

引数
src : AfmImg形式の画像
lowest : 数値
二値化のしきい値
highest : 数値（オプション）
最大値の指定。highestが指定されるとそれ以上の高さの部分が0.0nmになります。

戻り値
dst : AfmImg形式の画像
二値化（高さ1.0nmまたは0.0nm）された画像

apply_mask

apply_mask(src, mask)

AfmImg形式の画像にOpenCV形式のマスクを適用する関数です。

引数
src : AfmImg形式の画像
step : OpenCV形式のマスク

戻り値
dst : マスクが適用されたAfmImg形式の画像

heightCorrection

heightCorrection(src, makeItZero=False, peak_num=1, step=0.05)

高さヒストグラムからマイカ表面を認識し、マイカ表面が0.0nmになるように高さを修正する関数です。

引数
src : AfmImg形式の画像
makeItZero : bool型（オプション）
0.0nm以下をすべて0.0nmで置換するかどうか
peak_num : 整数（オプション）
低い方から数えて何個目のピークをマイカ表面とするか
step : 数値（オプション）
ヒストグラム取得の際のパラメーター

戻り値
dst : AfmImg形式の画像
高さが修正された画像

tiltCorrection

tiltCorrection(src, th_range=0.25)

マイカ表面を平面近似し、そのに基づいて傾きを補正する関数です。

引数
src : AfmImg形式の画像
th_range : 数値（オプション）
何nmまでをマイカ表面として扱うかを指定するか

戻り値
dst : AfmImg形式の画像
傾きが修正された画像

heightScaling

heightScaling(src, highest)

highestに指定した以上の高さをすべてhighestに置換する関数です。

引数
src : AfmImg形式の画像
highest : 数値
最大の高さ

戻り値
dst : AfmImg形式の画像
highest以上の部分がhighestに置換された画像